Mercurial > p > roundup > code

annotate doc/Makefile @ 7923:29a666d8a70d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
issue2551285 - Remove StructuredText support Asked on the users mailing list if anybody was using it. Got no responses. I have never seen CI installing structuredtext packages so it's untested as well.
author John Rouillard <rouilj@ieee.org>
date Tue, 30 Apr 2024 22:27:57 -0400
parents 6aa0525187cd
children 8b5f8b950f58
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7920
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
1 all: man_html tracker_config.txt
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
2 cd ..; ./setup.py build_doc
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
3
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
4 tracker_config.txt: ../roundup/configuration.py
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
5 # generate a current config file
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
6 python3 ../roundup/scripts/roundup_admin.py \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
7 genconfig _temp_config.txt
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
8
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
9 ## format and add directives to config file
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
10 # 1. delete first 8 lines of comments (1,8d)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
11 # Some sections have a comment block before the section
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
12 # [main] Put the comment block with the section marker
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
13 # after the index/code directives. To do this:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
14 # 2. Store all comment and blank lines in the hold space
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
15 # (H). Delete the current line and continue with the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
16 # next line (d).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
17 # 3. When we see a section marker, append the section
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
18 # marker to the hold space (H). substitute for the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
19 # section marker index and code directives
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
20 # (s/.../.../) using the section name (\1) for the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
21 # index. Print the directives (p). Empty (zero) the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
22 # pattern space (z). Pull the hold space to the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
23 # pattern space (x) (which also empties the hold space
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
24 # because of (z). Print the new pattern space
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
25 # [comments and section marker] (p). Delete the patern
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
26 # space and process next input line (d).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
27 # 4. For any other line, append the line to the hold
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
28 # space (H). Zero out the pattern buffer (z). Swap the
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
29 # hold space and pattern space [comments and setting
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
30 # line] (x).
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
31 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
32 # Automatically print the pattern space after the last
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
33 # command because we are not using 'sed -n'.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
34 #
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
35 # The last sed command indents every line that is not
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
36 # empty or does not start with '..' (a directive) with
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
37 # two spaces.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
38 # The cat -s squeezes adjacent blank lines to 1 blank
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
39 # line.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
40 @sed -e '1,8d' \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
41 -e '/^\#\|^$$/{H;d}' \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
42 -e '/^\[\([a-z]*\)\]/{H; s/^\[\([a-z]*\)\]/\n.. index:: config.ini; sections \1\n\n.. code:: ini/; p; z; x; p; d}' \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
43 -e '/./{H;z;x}' \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
44 _temp_config.txt | \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
45 sed -e '/^\.\.\|^$$/!s/^/ /' | \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
46 cat -s > tracker_config.txt
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
47 rm -f _temp_config.txt
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
48
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
49 ## generate html versions of man pages for inclusion in documentation
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
50 # find all man pages and generate output file paths.
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
51 MAN_ROFF=$(wildcard ../share/man/man1/*.1)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
52 MAN_HTML=$(patsubst ../share/man/man1/%.1,html_extra/man_pages/%.1.html,$(MAN_ROFF))
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
53
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
54 man_html: $(MAN_HTML)
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
55
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
56 html_extra/man_pages/%.1.html: ../share/man/man1/%.1
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
57 man --html=cat $< > $@
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
58 #man2html $< > $@
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
59
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
60 clean:
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
61 rm -f _temp_config.txt tracker_config.txt \
6aa0525187cd doc: use generated config.ini in reference.txt
John Rouillard <rouilj@ieee.org>
parents:
diff changeset
62 html_extra/man_pages/*.1.html
Roundup Issue Tracker: http://roundup-tracker.org/