Mercurial > p > roundup > code

view website/www/docs.txt @ 7492:452a8bd1d826

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add file with sphinx requirements for building doc. Disable permalinks for older and newer sphinx versions. make conf.py's work with old and new sphinx. make layout.py work with 7.x sphinx which replaces the style variable with styles[].
author John Rouillard <rouilj@ieee.org>
date Thu, 15 Jun 2023 20:46:59 -0400
parents e3b35dcf0dcb
children e3b34d02c61a
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

   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/license
   docs/acknowledgements
   olderdocs
Roundup Issue Tracker: http://roundup-tracker.org/