annotate website/www/olderdocs.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 2ab234484708
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1 Other Docs
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
2 ==========
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
3
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
4 .. toctree::
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
5 :maxdepth: 2
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
6
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
7 docs/upgrading-history
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
8
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
9 docs/tracker_templates
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
10
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
11 Design Overview <docs/overview>
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
12 Design (original) <docs/design>
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
13
7787
2ab234484708 docs: add older docs and link them from a Sphinx controlled doc
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
14 Software Carpentry and Short Papers <docs/sc>
2ab234484708 docs: add older docs and link them from a Sphinx controlled doc
John Rouillard <rouilj@ieee.org>
parents: 7322
diff changeset
15
7322
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
16 docs/developers
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
17
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
18 Notes about the MySQL Database backend <docs/mysql>
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
19 Notes about the PostgreSQL Database backend <docs/postgresql>
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
20
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
21 Richard Jones implementation notes <docs/implementation>
485cecfba982 Simplify TOC; older docs pushed a level down; Consolidate debugging
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
22 docs/security-history

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