Update api documentation (#254)

mfosterw · web-flow · commit b23d8cd7c41b · 2025-09-17T09:04:09.000-06:00
* Removed old search console verification

* fix docs make help

* Improve sphinx apidocs command

* Improve docs style

* Generate docs
diff --git a/democrasite/templates/base.html b/democrasite/templates/base.html
@@ -20,8 +20,6 @@
     <meta name="created" content="{% now 'jS M Y h:i' %}" />
     <meta name="description"
           content="A website which automatically incorporates changes from users based on popular approval" />
-    <meta name="google-site-verification"
-          content="B7IAH2JHzzr3L40rxXcl-mITWAod6ud_1rOWTh-taHA" />
     <link rel="icon" href="{% static 'images/favicons/favicon.ico' %}" />
     {% block css %}
       <!-- Latest compiled and minified Bootstrap CSS -->
diff --git a/docs/Makefile b/docs/Makefile
@@ -14,15 +14,15 @@ APP = ../democrasite
 
 # Put it first so that "make" without argument is like "make help".
 help:
-	@$(SPHINXBUILD) help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 # Build, watch and serve docs with live reload
 livehtml:
 	sphinx-autobuild -b html --host 0.0.0.0 --port 9000 --watch $(APP) -c . $(SOURCEDIR) $(BUILDDIR)/html
 
 # Outputs rst files from django application code
 apidocs:
-	sphinx-apidoc -e -M --tocfile democrasite -o $(SOURCEDIR)/api ../democrasite ../democrasite/contrib ../democrasite/*/migrations ../democrasite/*/tests
+	sphinx-apidoc -fMeT -o $(SOURCEDIR)/api ../democrasite ../democrasite/contrib ../democrasite/*/migrations ../democrasite/*/tests
 
 # Remove all autogenerated files, ensuring a new build picks up all changes
 clean:
diff --git a/docs/api/democrasite.activitypub.admin.rst b/docs/api/democrasite.activitypub.admin.rst
@@ -0,0 +1,7 @@
+democrasite.activitypub.admin module
+====================================
+
+.. automodule:: democrasite.activitypub.admin
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.activitypub.apps.rst b/docs/api/democrasite.activitypub.apps.rst
@@ -0,0 +1,7 @@
+democrasite.activitypub.apps module
+===================================
+
+.. automodule:: democrasite.activitypub.apps
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.activitypub.forms.rst b/docs/api/democrasite.activitypub.forms.rst
@@ -0,0 +1,7 @@
+democrasite.activitypub.forms module
+====================================
+
+.. automodule:: democrasite.activitypub.forms
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.activitypub.models.rst b/docs/api/democrasite.activitypub.models.rst
@@ -0,0 +1,7 @@
+democrasite.activitypub.models module
+=====================================
+
+.. automodule:: democrasite.activitypub.models
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.activitypub.rst b/docs/api/democrasite.activitypub.rst
@@ -0,0 +1,20 @@
+democrasite.activitypub package
+===============================
+
+.. automodule:: democrasite.activitypub
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   democrasite.activitypub.admin
+   democrasite.activitypub.apps
+   democrasite.activitypub.forms
+   democrasite.activitypub.models
+   democrasite.activitypub.urls
+   democrasite.activitypub.views
diff --git a/docs/api/democrasite.activitypub.urls.rst b/docs/api/democrasite.activitypub.urls.rst
@@ -0,0 +1,7 @@
+democrasite.activitypub.urls module
+===================================
+
+.. automodule:: democrasite.activitypub.urls
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.activitypub.views.rst b/docs/api/democrasite.activitypub.views.rst
@@ -0,0 +1,7 @@
+democrasite.activitypub.views module
+====================================
+
+.. automodule:: democrasite.activitypub.views
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.conftest.rst b/docs/api/democrasite.conftest.rst
@@ -4,3 +4,4 @@ democrasite.conftest module
 .. automodule:: democrasite.conftest
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.rst b/docs/api/democrasite.rst
@@ -4,13 +4,15 @@ democrasite package
 .. automodule:: democrasite
    :members:
    :show-inheritance:
+   :undoc-members:
 
 Subpackages
 -----------
 
 .. toctree::
    :maxdepth: 4
 
+   democrasite.activitypub
    democrasite.users
    democrasite.webiscite
 
diff --git a/docs/api/democrasite.users.adapters.rst b/docs/api/democrasite.users.adapters.rst
@@ -4,3 +4,4 @@ democrasite.users.adapters module
 .. automodule:: democrasite.users.adapters
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.admin.rst b/docs/api/democrasite.users.admin.rst
@@ -4,3 +4,4 @@ democrasite.users.admin module
 .. automodule:: democrasite.users.admin
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.api.rst b/docs/api/democrasite.users.api.rst
@@ -4,6 +4,7 @@ democrasite.users.api package
 .. automodule:: democrasite.users.api
    :members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
diff --git a/docs/api/democrasite.users.api.serializers.rst b/docs/api/democrasite.users.api.serializers.rst
@@ -4,3 +4,4 @@ democrasite.users.api.serializers module
 .. automodule:: democrasite.users.api.serializers
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.api.views.rst b/docs/api/democrasite.users.api.views.rst
@@ -4,3 +4,4 @@ democrasite.users.api.views module
 .. automodule:: democrasite.users.api.views
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.apps.rst b/docs/api/democrasite.users.apps.rst
@@ -4,3 +4,4 @@ democrasite.users.apps module
 .. automodule:: democrasite.users.apps
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.forms.rst b/docs/api/democrasite.users.forms.rst
@@ -4,3 +4,4 @@ democrasite.users.forms module
 .. automodule:: democrasite.users.forms
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.models.rst b/docs/api/democrasite.users.models.rst
@@ -4,3 +4,4 @@ democrasite.users.models module
 .. automodule:: democrasite.users.models
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.rst b/docs/api/democrasite.users.rst
@@ -4,6 +4,7 @@ democrasite.users package
 .. automodule:: democrasite.users
    :members:
    :show-inheritance:
+   :undoc-members:
 
 Subpackages
 -----------
diff --git a/docs/api/democrasite.users.urls.rst b/docs/api/democrasite.users.urls.rst
@@ -4,3 +4,4 @@ democrasite.users.urls module
 .. automodule:: democrasite.users.urls
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.users.views.rst b/docs/api/democrasite.users.views.rst
@@ -4,3 +4,4 @@ democrasite.users.views module
 .. automodule:: democrasite.users.views
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.admin.rst b/docs/api/democrasite.webiscite.admin.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.admin module
 .. automodule:: democrasite.webiscite.admin
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.api.rst b/docs/api/democrasite.webiscite.api.rst
@@ -4,6 +4,7 @@ democrasite.webiscite.api package
 .. automodule:: democrasite.webiscite.api
    :members:
    :show-inheritance:
+   :undoc-members:
 
 Submodules
 ----------
diff --git a/docs/api/democrasite.webiscite.api.serializers.rst b/docs/api/democrasite.webiscite.api.serializers.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.api.serializers module
 .. automodule:: democrasite.webiscite.api.serializers
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.api.views.rst b/docs/api/democrasite.webiscite.api.views.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.api.views module
 .. automodule:: democrasite.webiscite.api.views
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.apps.rst b/docs/api/democrasite.webiscite.apps.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.apps module
 .. automodule:: democrasite.webiscite.apps
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.constitution.rst b/docs/api/democrasite.webiscite.constitution.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.constitution module
 .. automodule:: democrasite.webiscite.constitution
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.context_processors.rst b/docs/api/democrasite.webiscite.context_processors.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.context\_processors module
 .. automodule:: democrasite.webiscite.context_processors
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.models.rst b/docs/api/democrasite.webiscite.models.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.models module
 .. automodule:: democrasite.webiscite.models
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.rst b/docs/api/democrasite.webiscite.rst
@@ -4,6 +4,7 @@ democrasite.webiscite package
 .. automodule:: democrasite.webiscite
    :members:
    :show-inheritance:
+   :undoc-members:
 
 Subpackages
 -----------
diff --git a/docs/api/democrasite.webiscite.tasks.rst b/docs/api/democrasite.webiscite.tasks.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.tasks module
 .. automodule:: democrasite.webiscite.tasks
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.urls.rst b/docs/api/democrasite.webiscite.urls.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.urls module
 .. automodule:: democrasite.webiscite.urls
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.views.rst b/docs/api/democrasite.webiscite.views.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.views module
 .. automodule:: democrasite.webiscite.views
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/api/democrasite.webiscite.webhooks.rst b/docs/api/democrasite.webiscite.webhooks.rst
@@ -4,3 +4,4 @@ democrasite.webiscite.webhooks module
 .. automodule:: democrasite.webiscite.webhooks
    :members:
    :show-inheritance:
+   :undoc-members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -58,9 +58,11 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "classic"
+html_theme = "pyramid"
 
 # 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"] # noqa: ERA001
+
+toc_object_entries_show_parents = "hide"
