-
-
Notifications
You must be signed in to change notification settings - Fork 549
Multiple issues with the new tox manpage #3878
Description
Issue
Thank you for fixing #1409! This is going to help simplify the Debian package and ensure consistency across distributions. Much appreciated!
I'm trying to switch the Debian package from the one I was shipping to your manpage but there are a few issues:
- This header at the top:
-************************************************
- virtualenv-based automation of test activities
-************************************************
-
-:Manual section: 1
-:Manual group: User Commands
...results in a whole section at the top of the manpage with that name. What's even worse is that the other sections (SYNOPSIS etc.) are then indented further. Removing these lines fixes this.
-
There is an AUTHOR section. However in the
conf.pyman_pagesconfig, authors is set totox-dev. This results in a second Author section. You can either set theman_pagesoption totox development teamand remove the AUTHOR section from the .rst, or change theman_pagesoption to "" and keep it in the .rst. -
There is a COPYRIGHT section, set to "MIT License" (which, btw, is the license, not the copyright). However sphinx-argparse-cli generates its own copyright section, relying on the
copyright(orproject_copyright) configuration option. I'd recommend changing the COPYRIGHT section from the .rst. -
pyproject.tomlhasbuild.targets.wheel.shared-data = { "docs/man" = "share/man/man1" }. However, this just ships the source, rather than the generated manpage, i.e. tox.1.rst, rather tox.1 (e.g. using pipx install:.local/share/man/man1/tox.1.rst). -
The manpage says "Project name not set" at the top. This is because
projectis not defined inconf.py.
Environment
- OS: Debian unstables
Output of pip list of the host Python, where tox is installed
root@e6dae0561da5:~# pipx list
venvs are in /root/.local/share/pipx/venvs
apps are exposed on your $PATH at /root/.local/bin
manual pages are exposed at /root/.local/share/man
package tox 4.49.1, installed using Python 3.13.12
- tox
- man1/tox.1.rst