Mercurial > p > roundup > code
view website/www/docs.txt @ 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 | e3b34d02c61a |
| children |
line wrap: on
line source
.. meta:: :description: Table of contents for published documentation on the Roundup Issue Tracker. Docs ==== .. admonition:: Welcome The documentation is slowly being reorganized using the `Diataxis framework`_. Help with the reorganization is welcome. If a page you used to see is missing, try checking the `Other Docs <olderdocs.html>`_ page. See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to documentation. .. _diataxis framework: https://diataxis.fr/ .. toctree:: :maxdepth: 2 :includehidden: Features <docs/features> Installation <docs/installation> Upgrading to Newer Versions <docs/upgrading> Security Issues <docs/security> FAQ <docs/FAQ> User's Guide <docs/user_guide> Customising <docs/customizing> Rest API <docs/rest> XML-RPC API <docs/xmlrpc> Reference <docs/reference> Glossary <docs/glossary> docs/admin_guide docs/man_pages docs/license docs/acknowledgements olderdocs .. toctree:: :hidden: docs/pydoc