Add documentation generation with Sphinx

This commit is contained in:
Logan Williams
2022-02-21 17:52:38 +01:00
parent 139459e3b2
commit e3d29bf811
54 changed files with 18250 additions and 8 deletions

30
docs/source/cisticola.rst Normal file
View File

@@ -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: