The build backend configuration in pyproject.toml
is already setup for including manpage that pipx can install in a specific folder. Users who add this folder to their MANPATH can then type man your-cli
to get some help 👍
I had spent some time integrating mkdocs-manpage into this template, but there were two things I disliked about this approach:
I'd really prefer a specially crafted manpage that reflects the CLI only, just like regular man pages for GNU/Linux tools. The rest of the documentation can stay online, as HTML.
I believe it's easy enough to write a script that generates Groff from an argparse/Cappa CLI, like click-man does. This script could either live in generated project, or I could create a new package. If the latter, this could be listed in Cappa's docs 😉
Pay now to fund the work behind this issue.
Get updates on progress being made.
Maintainer is rewarded once the issue is completed.
You're funding impactful open source efforts
You want to contribute to this effort
You want to get funding like this too