Update docs with docstring API

joshua-hampton · joshua-hampton · commit 147f80bdc2e5 · 2025-04-23T12:03:54.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -65,6 +65,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/source/dev/generated/
 
 # PyBuilder
 target/
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'checksit'
-copyright = '2024, Ag Stephens, Hugo Ricketts, Joshua Hampton'
+copyright = '2025, Ag Stephens, Hugo Ricketts, Joshua Hampton'
 author = 'Ag Stephens, Hugo Ricketts, Joshua Hampton'
 release = '0.1'
 
@@ -16,8 +16,17 @@
 
 extensions = [
     "sphinx_rtd_theme",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
 ]
 
+autodoc_default_options = {
+    "members": True,
+    "member-order": "groupwise",
+}
+
 templates_path = ['_templates']
 exclude_patterns = []
 
diff --git a/docs/source/dev/api.rst b/docs/source/dev/api.rst
@@ -0,0 +1,17 @@
+API
+===
+
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+
+   checksit.check
+   checksit.cli
+   checksit.cvs
+   checksit.generic
+   checksit.readers
+   checksit.rules
+   checksit.specs
+   checksit.summary
+   checksit.utils
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -28,6 +28,7 @@ Other options include specifying the particular checks to run or to compare with
    dev/templates
    dev/vocabs
    dev/ncas_standard_specifics
+   dev/api
 
 .. toctree::
    :caption: Links
