added docstrings, improved Sphinx docs

This commit is contained in:
Tristan Lee
2022-03-14 18:04:27 -05:00
parent 6cf3b8842d
commit e4cf9daf73
25 changed files with 700 additions and 311 deletions

View File

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