Closes #2554 (closed).
This MR makes one-word mentions of binaries, commands, and hook libraries reference to their own sections. Several commands had typos that should now be fixed. Also the logger table was missing quite a few logers which were added.
Here's this branch in readthedocs: https://kea.readthedocs.io/en/2554-arm-make-parameter-names-clickable/
-
7def293a simplify PDF building Removed a lot of commands in the Makefile that were repeated. Removed makeindex command because it doesn't seem required. PDF is now built in seconds rather than minutes, and thousands of verbose build output lines are now gone.
-
04eff8dc bump up sphinx dependency versions Not strictly required for referencing binaries to manpages.
-
34ed1df0 add the 'iscman' cross-reference role -
043880cf add the 'isccmd' cross-reference role -
83f64a4f add the 'ischooklib' cross-reference role -
70a36db6 add 'isccmd' anchors -
35d072b6 add 'iscman' anchor to all manpages -
5db59e30 add 'iscman' references The commands used were:
find doc/sphinx/man -name '*.rst' | xargs grep -F '.. iscman' | cut -d ' ' -f 3 > /tmp/binaries-
for i in $(cat /tmp/binaries); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/\`{i}``/:iscman:`{i}`/g"; done`
Manual adjustment was required in a few places to:
- extend title lines
- realign table lines
-
fe6b9ab7 add 'isccmd' references The commands used were:
find doc/sphinx/arm -name '*.rst' | xargs grep -E '^\.\. ' | cut -d ' ' -f 2 | sort -uV | grep _command- > /tmp/commands-
for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/\`{i}`` command/`{i} command <_command-${i}>`/g"; done` -
for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/\`{i}``/`{i} <_command-${i}>`/g"; done` -
for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/The \${i} <_command-${i}>` Command/The ``${i}`` Command/g"; done` -
for i in $(cat /tmp/commands); do find doc/sphinx/arm -name '*.rst' | xargs sed -i "s/- ${i}/- \${i} <_command-${i}>`/g"; done`
But they were not perfect. Some manual adjustment was required.
-
437b11d7 add 'ischooklib' anchors and references -
a75aacfd add missing loggers
#huge-sorry