Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to referenced manual sections #789

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ewie
Copy link

@ewie ewie commented Apr 24, 2023

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 change doc/Dockerfile to use base image debian:buster as Stretch is EOL, causing apt-get update to fail. Also need to install package texlive-fonts-recommended and remove latex-xcolor and texlive-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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant