Mercurial > p > roundup > code
view doc/index.txt @ 7371:a210f4437b49
Incomplete work to generate config doc from config.ini
This is an incomplete attempt to allow generation of the config.ini
documentation in reference.txt. It reformats the output of
'roundup_admin.py genconfig'. So it now includes all of the
settings. Using a Makefile rule like:
tracker_config.txt: ../roundup/configuration.py
python3 ../roundup/scripts/roundup_admin.py \
genconfig _temp_config.txt
sed -e '1,8d' \
-e 's/^\[\([a-z]*\)\]/\n.. index:: config.ini; sections \1\n\n.. code:: ini\n\n [\1]/' \
-e 's/^\([^[]\)/ \1/' \
_temp_config.txt > tracker_config.txt
rm -f _temp_config.txt
results in the config.ini split by section and index links being put
in place. However some sections have a comment before the [section]
marker. This comment is orphaned at the end of the prior section
rather than starting the new section. A simple sed won't allow the
lookahead needed to target the [section] marker and include the prior
comment block. Also there are still have some long lines generated (>
65 characters). Maybe a python script can import configuration.py and
output proper restructured text output?
reference.txt:
add a commented out include:: tracker_config.txt directive
roundup/admin.py:
don't require a tracker home for genconfig. So user can generate a
clean config.ini on demand. Tracker home is still required for
updateconfig.
roundup/configuration.py:
wrap lines better. A number of them are generating comments > 65
characters which is the targeted line length. This cleans up
config.ini too, so is a good thing.
website/www/conf.py:
ignore doc/tracker_config.ini when processing.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 17 May 2023 13:34:36 -0400 |
| parents | 24101267e3fb |
| children | a072331c843b |
line wrap: on
line source
.. meta:: :description: Table of contents for documentation on the Roundup Issue Tracker. ======================================================= Roundup: an Issue-Tracking System for Knowledge Workers ======================================================= For how to contact the community see https://www.roundup-tracker.org . Contents ======== .. toctree:: :maxdepth: 2 features installation upgrading security FAQ user_guide customizing rest xmlrpc reference glossary admin_guide license acknowledgements upgrading-history tracker_templates Design Overview <overview> Design (original) <design> developers Notes about the MySQL Database backend <mysql> Notes about the PostgreSQL Database backend <postgresql> Richard Jones implementation notes <implementation> security-history See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to documentation. Indices ======= * :ref:`genindex`
