Mercurial > p > roundup > code
view website/www/docs.txt @ 8271:8824c81cc431
doc: add make help to all Makefiles and fix 2 Makefiles
Use automatic help generator for help target that extracts help text
from makefile comments.
Reordered a number of targets to use grouping mechanism in help
generator.
A couple of multiple target rules had to be split because:
target1 target2: ... ## help comment
doesn't work with the help generator.
In locale Makefile, the TEMPLATES variable was not set so changes to
the html files in the templates would not trigger regeneration of the
roundup.pot template.
In doc Makefile, made admin_help.html generate the file rather than
putting it into admin_help.py. Verified that the file shows up at end
of admin_guide.html.
In www makefile, fixed docs link generation.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 12 Jan 2025 18:22:40 -0500 |
| parents | 78b13272d41b |
| 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