diff website/www/conf.py @ 8263:78b13272d41b

docs: link to Client and TemplatingUtils class/method docstrings pydoc.txt: new page. Has two example autodoc invocations: automethod and autoclass. docs.txt Added pydoc.txt as a hidden page in a new toc in docs.txt. Added includehidden in toc directive.Not sure what it does, but was part of a recipie to hide the pydoc from the main TOC. conf.py: added sphinx.ext.autodoc to get it pulling in the docs. reference.txt: added references to the pydoc using :py:meth: for templating utils methods like set-http_response and :py:class: for Client as the existing docs referenced the docstrings. Changed table formatting for the TemplatingUtils methods from table to list-table. The length of the references to the methods was too large to exist in the first column of a drawn table. For right now the pydoc stuff is only referenced via links from the main docs. Currently it is ugly, but the additional info on tempating utils and their arguments can be helpful. Added sphin
author John Rouillard <rouilj@ieee.org>
date Tue, 07 Jan 2025 23:00:35 -0500
parents c80de1b0dd83
children 6cf700cae7f6
line wrap: on
line diff
--- a/website/www/conf.py	Tue Jan 07 20:22:33 2025 -0500
+++ b/website/www/conf.py	Tue Jan 07 23:00:35 2025 -0500
@@ -45,9 +45,10 @@
 # General configuration
 # ---------------------
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ["sphinxext.opengraph", 'sphinx_sitemap', 'sphinx_tabs.tabs',]
+# Add any Sphinx extension module names here, as strings. They can be
+#  extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinxext.opengraph',
+              'sphinx_sitemap', 'sphinx_tabs.tabs']
 
 sphinx_tabs_valid_builders = ['linkcheck']
 sphinx_tabs_disable_tab_closing = True

Roundup Issue Tracker: http://roundup-tracker.org/