Skip to content

Commit bb0783e

Browse files
committed
docs: add roundup-admin interactive help output to admin_guide.txt
This only works for html output. It is recreated if admin.py changes.
1 parent 382f27d commit bb0783e

File tree

3 files changed

+510
-2
lines changed

3 files changed

+510
-2
lines changed

doc/Makefile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
all: man_html tracker_config.txt
1+
all: man_html tracker_config.txt admin_help.html
22
cd ..; ./setup.py build_doc
33

44
tracker_config.txt: ../roundup/configuration.py
@@ -23,6 +23,10 @@ html_extra/man_pages/%.1.html: ../share/man/man1/%.1
2323
sed -i '/<style/,/<\/style/s/\(p\s* { \)margin/\1max-width: 65ch; margin/' $@
2424
#man2html $< > $@
2525

26+
admin_help.html: ../roundup/admin.py
27+
python3 ../roundup/scripts/roundup_admin.py htmlhelp > admin_help.py
28+
2629
clean:
2730
rm -f _temp_config.txt tracker_config.txt \
28-
html_extra/man_pages/*.1.html
31+
html_extra/man_pages/*.1.html \
32+
admin_help.py

doc/admin_guide.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2023,6 +2023,14 @@ used differently. You can't directly compare them.
20232023
Importing and setting numbers. It's not a problem. However setting
20242024
can (and must) always be higher than the Importing number.
20252025

2026+
Interactive Help
2027+
----------------
2028+
2029+
The help command produces the following output for all the commands.
2030+
2031+
2032+
.. raw:: html
2033+
:file: admin_help.html
20262034

20272035
.. _`customisation documentation`: customizing.html
20282036
.. _`reference documentation`: reference.html

0 commit comments

Comments
 (0)