Add documentation generation with Sphinx

docs/source/cisticola.rst

@@ -0,0 +1,30 @@
+cisticola package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cisticola.scraper
+   cisticola.transformer
+
+Submodules
+----------
+
+cisticola.base module
+---------------------
+
+.. automodule:: cisticola.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cisticola
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cisticola.scraper.rst

@@ -0,0 +1,37 @@
+cisticola.scraper package
+=========================
+
+Submodules
+----------
+
+cisticola.scraper.bitchute module
+---------------------------------
+
+.. automodule:: cisticola.scraper.bitchute
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cisticola.scraper.gettr module
+------------------------------
+
+.. automodule:: cisticola.scraper.gettr
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cisticola.scraper.twitter module
+--------------------------------
+
+.. automodule:: cisticola.scraper.twitter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cisticola.scraper
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/cisticola.transformer.rst

@@ -0,0 +1,21 @@
+cisticola.transformer package
+=============================
+
+Submodules
+----------
+
+cisticola.transformer.twitter module
+------------------------------------
+
+.. automodule:: cisticola.transformer.twitter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cisticola.transformer
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -0,0 +1,51 @@
+# 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, os.path.abspath('../../'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Cisticola'
+copyright = '2022, Bellingcat'
+author = 'Bellingcat'
+
+
+# -- 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.coverage', 'sphinx.ext.napoleon']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = []
+
+
+# -- 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']

docs/source/index.rst

@@ -0,0 +1,17 @@
+Welcome to Cisticola's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+cisticola
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   cisticola