Mercurial > p > roundup > code
annotate 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 |
| rev | line source |
|---|---|
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
1 .. meta:: |
|
6774
e7b4ad2c57ac
landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents:
6586
diff
changeset
|
2 :description: |
|
6586
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
3 Table of contents for documentation on the Roundup Issue Tracker. |
|
24e2eeb2ed9a
Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents:
6265
diff
changeset
|
4 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
5 ======================================================= |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
6 Roundup: an Issue-Tracking System for Knowledge Workers |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
7 ======================================================= |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
8 |
|
6265
b2eb59ada444
Replace http:....roundup-tracker.org with https. Also fix wiki links.
John Rouillard <rouilj@ieee.org>
parents:
6160
diff
changeset
|
9 For how to contact the community see https://www.roundup-tracker.org . |
|
4610
e793eafba69c
Documentation: Synced the doc/index.txt and docs.txt. Removed outdated contact.txt.
Bernhard Reiter <bernhard@intevation.de>
parents:
4440
diff
changeset
|
10 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
11 Contents |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
12 ======== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
13 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
14 .. toctree:: |
|
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
15 :maxdepth: 2 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
16 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
17 features |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
18 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
19 installation |
|
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
20 upgrading |
| 7092 | 21 security |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
22 FAQ |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
23 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
24 user_guide |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
25 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
26 customizing |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
27 rest |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
28 xmlrpc |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
29 reference |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
30 glossary |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
31 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
32 admin_guide |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
33 license |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
34 acknowledgements |
|
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
35 |
|
7283
1a0548b60c6b
Update document TOC with security-history, reference, upgrading-history
John Rouillard <rouilj@ieee.org>
parents:
7100
diff
changeset
|
36 upgrading-history |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
37 |
|
7100
8a267e9827cc
Integrate security.txt with website docs. Align TOCs.
John Rouillard <rouilj@ieee.org>
parents:
7096
diff
changeset
|
38 tracker_templates |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
39 |
|
7100
8a267e9827cc
Integrate security.txt with website docs. Align TOCs.
John Rouillard <rouilj@ieee.org>
parents:
7096
diff
changeset
|
40 Design Overview <overview> |
|
4890
609edf9de0a5
docs: Remove one nesting level from ToC on subpages
anatoly techtonik <techtonik@gmail.com>
parents:
4746
diff
changeset
|
41 Design (original) <design> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
42 |
|
4033
bca7c59ac400
Enhance documentation generation.
Stefan Seefeld <stefan@seefeld.name>
parents:
4000
diff
changeset
|
43 developers |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
44 |
|
5078
487dc55e3c5e
issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
45 Notes about the MySQL Database backend <mysql> |
|
487dc55e3c5e
issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
46 Notes about the PostgreSQL Database backend <postgresql> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
47 |
|
5078
487dc55e3c5e
issue2550907 Fix errors when creating documentation. Work done by
John Rouillard <rouilj@ieee.org>
parents:
4890
diff
changeset
|
48 Richard Jones implementation notes <implementation> |
|
7331
24101267e3fb
Reorder docs to match web site docs.
John Rouillard <rouilj@ieee.org>
parents:
7283
diff
changeset
|
49 security-history |
|
5925
7cf8f6389aad
issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents:
5695
diff
changeset
|
50 |
|
7cf8f6389aad
issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents:
5695
diff
changeset
|
51 See: https://wiki.roundup-tracker.org/ReleaseErrata for fixes to |
|
7cf8f6389aad
issue2551002: Add reference to wiki ReleaseErrata page to docs.
John Rouillard <rouilj@ieee.org>
parents:
5695
diff
changeset
|
52 documentation. |
|
6160
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
53 |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
54 Indices |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
55 ======= |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
56 |
|
9619d64c0351
Doc updates for customizing.txt, start of index generation
John Rouillard <rouilj@ieee.org>
parents:
5925
diff
changeset
|
57 * :ref:`genindex` |
