Skip to content

RST man pages - #1285

Merged
gthess merged 15 commits into
masterfrom
test-rst-man
May 20, 2025
Merged

gthess merged 15 commits into
masterfrom
test-rst-man

Conversation

@gthess

@gthess gthess commented May 13, 2025

Copy link
Copy Markdown
Member

This PR introduces restructuredText man pages to sync the online and source code man page documentation.
The templated man pages (*.in) are still part of the repo but generated with docutils from their .rst counterpart.

@gthess gthess self-assigned this May 13, 2025
@gthess

gthess commented May 14, 2025

Copy link
Copy Markdown
Member Author

The RST man pages are synced with their troff counterparts from master and the templated man pages (*.in) are now generated from the RST pages.

@gthess

gthess commented May 14, 2025

Copy link
Copy Markdown
Member Author

This is now ready for review.
There is documentation in README.man on how to manage the man pages going forward.

(Paired with NLnetLabs/unbound-manual#62)

@gthess
gthess marked this pull request as ready for review May 14, 2025 14:32
in the HTML output. Also the generated templates from that.
@gthess

gthess commented May 20, 2025

Copy link
Copy Markdown
Member Author

The last commit just adds the UAHL templating to create proper hover links for the HTML output. Content and output stays the same for the man pages (well an extra space after the options that use the templating).
Merging to master.

@gthess
gthess merged commit 6662f71 into master May 20, 2025
@gthess
gthess deleted the test-rst-man branch May 20, 2025 10:20
gthess added a commit that referenced this pull request May 20, 2025
- Merge #1285:  RST man pages.
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