added docstrings, improved Sphinx docs

docs/source/cisticola.base.rst

@@ -0,0 +1,8 @@
+cisticola.base module
+=====================
+
+.. automodule:: cisticola.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.rst

@@ -1,6 +1,12 @@
 cisticola package
 =================
 
+.. automodule:: cisticola
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:
+
 Subpackages
 -----------
 
@@ -13,18 +19,7 @@ Subpackages
 Submodules
 ----------
 
-cisticola.base module
----------------------
+.. toctree::
+   :maxdepth: 4
 
-.. automodule:: cisticola.base
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: cisticola
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   cisticola.base

docs/source/cisticola.scraper.base.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.base module
+=============================
+
+.. automodule:: cisticola.scraper.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.bitchute.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.bitchute module
+=================================
+
+.. automodule:: cisticola.scraper.bitchute
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.gab.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.gab module
+============================
+
+.. automodule:: cisticola.scraper.gab
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.gettr.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.gettr module
+==============================
+
+.. automodule:: cisticola.scraper.gettr
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.odysee.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.odysee module
+===============================
+
+.. automodule:: cisticola.scraper.odysee
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.rst

@@ -1,37 +1,25 @@
 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:
+   :private-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cisticola.scraper.base
+   cisticola.scraper.bitchute
+   cisticola.scraper.gab
+   cisticola.scraper.gettr
+   cisticola.scraper.odysee
+   cisticola.scraper.rumble
+   cisticola.scraper.telegram_snscrape
+   cisticola.scraper.telegram_telethon
+   cisticola.scraper.twitter
+   cisticola.scraper.utils

docs/source/cisticola.scraper.rumble.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.rumble module
+===============================
+
+.. automodule:: cisticola.scraper.rumble
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.telegram_snscrape.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.telegram\_snscrape module
+===========================================
+
+.. automodule:: cisticola.scraper.telegram_snscrape
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.telegram_telethon.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.telegram\_telethon module
+===========================================
+
+.. automodule:: cisticola.scraper.telegram_telethon
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.twitter.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.twitter module
+================================
+
+.. automodule:: cisticola.scraper.twitter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.scraper.utils.rst

@@ -0,0 +1,8 @@
+cisticola.scraper.utils module
+==============================
+
+.. automodule:: cisticola.scraper.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.transformer.base.rst

@@ -0,0 +1,8 @@
+cisticola.transformer.base module
+=================================
+
+.. automodule:: cisticola.transformer.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/cisticola.transformer.rst

@@ -1,21 +1,17 @@
 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:
+   :private-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   cisticola.transformer.base
+   cisticola.transformer.twitter

docs/source/cisticola.transformer.twitter.rst

@@ -0,0 +1,8 @@
+cisticola.transformer.twitter module
+====================================
+
+.. automodule:: cisticola.transformer.twitter
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :private-members:

docs/source/conf.py

@@ -43,9 +43,18 @@ exclude_patterns = []
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # 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 = []
+
+# -- Default flags for autodoc------------------------------------------------
+
+autodoc_default_options = {'exclude-members': '_sa_class_manager'}
+
+html_favicon = '../images/favicon.ico'
+html_logo = '../images/cisticola_logo.svg'
+
+html_theme_options = {'style_nav_header_background': '#000000'}

docs/source/index.rst

@@ -5,7 +5,7 @@ Welcome to Cisticola's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   modules
+   cisticola
 
 
 

docs/source/modules.rst

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