SpiderFoot automates OSINT for threat intelligence and mapping your attack surface.
Python attacksurfacecticybersecurityfootprintinghackinginformation-gatheringinformation-securityinfosecintelligence-gatheringosintosint-frameworkosint-reconnaissanceosint-toolpentestingpythonreconsecurity-toolsthreat-intelligencethreatintel
docs: Add sphinx documentation config (#1206)
bcolesa677d3105d2f
diff --git a/docs/Makefile b/docs/Makefilenew file mode 100644index 00000000..d4bb2cbb--- /dev/null+++ b/docs/Makefile@@ -0,0 +1,20 @@+# Minimal makefile for Sphinx documentation+#++# You can set these variables from the command line, and also+# from the environment for the first two.+SPHINXOPTS ?=+SPHINXBUILD ?= sphinx-build+SOURCEDIR = .+BUILDDIR = _build++# Put it first so that "make" without argument is like "make help".+help:+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)++.PHONY: help Makefile++# Catch-all target: route all unknown targets to Sphinx using the new+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).+%: Makefile+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)diff --git a/docs/conf.py b/docs/conf.pynew file mode 100644index 00000000..5e2c959a--- /dev/null+++ b/docs/conf.py@@ -0,0 +1,71 @@+# Configuration file for the Sphinx documentation builder.+#+# This file only contains a selection of the most common options. For a full+# list see the documentation:+# https://www.sphinx-doc.org/en/master/usage/configuration.html++# -- Path setup --------------------------------------------------------------++# If extensions (or modules to document with autodoc) are in another directory,+# add these directories to sys.path here. If the directory is relative to the+# documentation root, use os.path.abspath to make it absolute, like shown here.+#+# import os+# import sys+# sys.path.insert(0, '/root/Desktop/spiderfoot/spiderfoot')+++# -- Project information -----------------------------------------------------++project = 'SpiderFoot'+copyright = '2012, Steve Micallef'+author = 'Steve Micallef'+++# -- General configuration ---------------------------------------------------++# Add any Sphinx extension module names here, as strings. They can be+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom+# ones.+extensions = [+ 'sphinx.ext.autodoc',+ 'sphinx.ext.napoleon',+ 'sphinx.ext.viewcode',+ 'sphinx.ext.todo',+]++# Add any paths that contain templates here, relative to this directory.+templates_path = ['_templates']++# The language for content autogenerated by Sphinx. Refer to documentation+# for a list of supported languages.+#+# This is also used if you do content translation via gettext catalogs.+# Usually you set "language" from the command line for these cases.+language = 'en'++# List of patterns, relative to source directory, that match files and+# directories to ignore when looking for source files.+# This pattern also affects html_static_path and html_extra_path.+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']+++# -- Options for HTML output -------------------------------------------------++# The theme to use for HTML and HTML Help pages. See the documentation for+# a list of builtin themes.+#+html_theme = 'alabaster'++# Add any paths that contain custom static files (such as style sheets) here,+# relative to this directory. They are copied after the builtin static files,+# so a file named "default.css" will overwrite the builtin "default.css".+html_static_path = ['_static']+++# -- Extension configuration -------------------------------------------------++# -- Options for todo extension ----------------------------------------------++# If true, `todo` and `todoList` produce output, else they produce nothing.+todo_include_todos = Truediff --git a/docs/index.rst b/docs/index.rstnew file mode 100644index 00000000..6f52ec3e--- /dev/null+++ b/docs/index.rst@@ -0,0 +1,21 @@+.. spiderfoot documentation master file, created by+ sphinx-quickstart on Sat Jun 26 01:55:34 2021.+ You can adapt this file completely to your liking, but it should at least+ contain the root `toctree` directive.++Welcome to spiderfoot's documentation!+======================================++.. toctree::+ :maxdepth: 4+ :caption: Contents:++ spiderfoot+++Indices and tables+==================++* :ref:`genindex`+* :ref:`modindex`+* :ref:`search`diff --git a/docs/make.bat b/docs/make.batnew file mode 100644index 00000000..2119f510--- /dev/null+++ b/docs/make.bat@@ -0,0 +1,35 @@+@ECHO OFF++pushd %~dp0++REM Command file for Sphinx documentation++if "%SPHINXBUILD%" == "" (+ set SPHINXBUILD=sphinx-build+)+set SOURCEDIR=.+set BUILDDIR=_build++if "%1" == "" goto help++%SPHINXBUILD% >NUL 2>NUL+if errorlevel 9009 (+ echo.+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx+ echo.installed, then set the SPHINXBUILD environment variable to point+ echo.to the full path of the 'sphinx-build' executable. Alternatively you+ echo.may add the Sphinx directory to PATH.+ echo.+ echo.If you don't have Sphinx installed, grab it from+ echo.http://sphinx-doc.org/+ exit /b 1+)++%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%+goto end++:help+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%++:end+popddiff --git a/docs/spiderfoot.rst b/docs/spiderfoot.rstnew file mode 100644index 00000000..44970697--- /dev/null+++ b/docs/spiderfoot.rst@@ -0,0 +1,53 @@+spiderfoot package+==================++Submodules+----------++spiderfoot.db module+--------------------++.. automodule:: spiderfoot.db+ :members:+ :undoc-members:+ :show-inheritance:++spiderfoot.event module+-----------------------++.. automodule:: spiderfoot.event+ :members:+ :undoc-members:+ :show-inheritance:++spiderfoot.helpers module+-------------------------++.. automodule:: spiderfoot.helpers+ :members:+ :undoc-members:+ :show-inheritance:++spiderfoot.plugin module+------------------------++.. automodule:: spiderfoot.plugin+ :members:+ :undoc-members:+ :show-inheritance:++spiderfoot.target module+------------------------++.. automodule:: spiderfoot.target+ :members:+ :undoc-members:+ :show-inheritance:++Module contents+---------------++.. automodule:: spiderfoot+ :members:+ :undoc-members:+ :show-inheritance: