Add links to referenced manual sections #789
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the manual by linking to referenced sections instead of just referencing section names and have readers search the text.
The links work in HTML and PDF when building with
doc/build/build. But I had to changedoc/Dockerfileto use base imagedebian:busteras Stretch is EOL, causingapt-get updateto fail. Also need to install packagetexlive-fonts-recommendedand removelatex-xcolorandtexlive-math-extra. The Dockerfile change is not included in this PR because I don't know if there are already plans to fix the doc build.Unfortunately, Pandoc does not warn or fail on unknown anchors. This is prone to typos, as are references to section names.