🐛 fix(docs): resolve multiple manpage issues#3881
Merged
gaborbernat merged 2 commits intotox-dev:mainfrom Mar 16, 2026
Merged
Conversation
rahuldevikar
approved these changes
Mar 16, 2026
5d63c70 to
0fa95e7
Compare
Add a hatch build hook using docutils to compile the manpage to troff at wheel-build time so tox man and pip/pipx/uv installs get a working tox.1 file. Remove the RST header block and field-list (handled by man_pages config), remove the COPYRIGHT section (generated by Sphinx from conf.py), set project in conf.py, and clear man_pages authors list (AUTHOR kept in RST). Fixes tox-dev#3878
for more information, see https://pre-commit.ci
This file contains hidden or 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.
Downstream packagers (Debian) reported several problems with the tox manpage introduced in #1409. The RST title block and field-list metadata created a malformed top section where
SYNOPSISand other headings were indented under an unwanted parent section. Bothman_pagesconfig and the RST source generated their ownAUTHORandCOPYRIGHTsections, producing duplicates. Theprojectvariable was never set inconf.py, causing"Project name not set"to appear in the manpage header. Finally,shared-datashipped the raw.rstsource file rather than a compiled troff manpage, sotox manandman toxnever worked.The RST header block is removed since
man_pagesalready handles the title, section, and description. TheAUTHORsection is kept only in the RST (with the GitHub link) while clearing theman_pagesauthors list to prevent duplication. TheCOPYRIGHTsection is removed from the RST since Sphinx generates one fromconf.py. Settingproject = namefixes the header. A hatch build hook using docutils now compiles the manpage to troff format at wheel-build time, so pip, pipx, anduv tool installall get a workingtox.1-- andtox mancan find and symlink it correctly.Fixes #3878