Mercurial > p > roundup > code
comparison doc/reference.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 | f37c1df6de34 |
| children | 9bd7ed918121 |
comparison
equal
deleted
inserted
replaced
| 7370:f37c1df6de34 | 7371:a210f4437b49 |
|---|---|
| 114 | 114 |
| 115 Example configuration settings are below. This is a partial | 115 Example configuration settings are below. This is a partial |
| 116 list. Documentation on all the settings is included in the | 116 list. Documentation on all the settings is included in the |
| 117 ``config.ini`` file. | 117 ``config.ini`` file. |
| 118 | 118 |
| 119 .. .comment out. file generation needs more work include:: tracker_config.txt | |
| 120 | |
| 119 .. index:: config.ini; sections main | 121 .. index:: config.ini; sections main |
| 120 | 122 |
| 121 Section **main** | 123 Section **main** |
| 122 database -- ``db`` | 124 database -- ``db`` |
| 123 Database directory path. The path may be either absolute or relative | 125 Database directory path. The path may be either absolute or relative |
