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

manpage documentation is missing all subcommands #6724

Closed
eli-schwartz opened this issue Jul 18, 2019 · 1 comment
Closed

manpage documentation is missing all subcommands #6724

eli-schwartz opened this issue Jul 18, 2019 · 1 comment

Comments

@eli-schwartz
Copy link
Contributor

@eli-schwartz eli-schwartz commented Jul 18, 2019

Initially reported in Arch Linux as: https://bugs.archlinux.org/task/63223

To reproduce:

git clone https://github.com/pypa/pip/
cd pip/docs
PYTHONPATH=$PWD/../src/ sphinx-build -W -b man -d build/doctrees/man man build/man -c html

Look in build/man and you will see only one manpage: pip.1

Really quick reproducer: look at a recent Travis CI build for the TOXENV=docs results, for example https://travis-ci.org/pypa/pip/jobs/559973823#L388, and see only one file being written out.

Expectation: There should be lots of manpages, one for each pip subcommand, and linux distro packages which install the docs/build/man/ directory to /usr/share/man/man1/ should be able to read all about pip's many excellent features in their offline documentation reader.

The cause of this breakage is #5724, which reorganized the conf.py layout due to readthedocs/readthedocs.org#1543 but did not adapt the somewhat hacky code to automatically add new entries.

@pradyunsg
Copy link
Member

@pradyunsg pradyunsg commented Jul 18, 2019

Makes sense. Happy to merge your fix conditional to a minor nitpick. 🙃

Loading

@lock lock bot added the S: auto-locked label Aug 20, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Aug 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

3 participants