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 #686

Closed
williamjmorenor opened this Issue Jul 8, 2015 · 5 comments

Comments

Projects
None yet
3 participants
@williamjmorenor

williamjmorenor commented Jul 8, 2015

Hi

I am working in package mkdocs in Fedora, I am getting a warning because mkdocs do not ship a manpage,:

rpmlint rpmbuild/RPMS/noarch/mkdocs-0.14.0-1.fc22.noarch.rpm
mkdocs.noarch: W: no-manual-page-for-binary mkdocs

Can please add a mange to mkdocs tarball

@d0ugal

This comment has been minimized.

Member

d0ugal commented Jul 9, 2015

Hi, sure - we can do this. I just need to first learn how :)

@d0ugal d0ugal added the Enhancement label Jul 9, 2015

@waylan

This comment has been minimized.

Member

waylan commented Jul 9, 2015

There are a few tools out there that will convert optparse/argparse help to man page. I know Click is built on top of optparse (sort of), but not sure if they would work.

@williamjmorenor

This comment has been minimized.

@waylan waylan added this to the 1.0.0 milestone Dec 2, 2016

@waylan waylan self-assigned this Dec 2, 2016

@waylan

This comment has been minimized.

Member

waylan commented May 11, 2017

I took another look at this and found click-man, which is a tool that creates man pages for Click applications. You install the tool and run one command and all your man pages are generated (one per command/subcommand). Interestingly, the docs for the package explain why we shouldn't automate that on build (rather than documenting how to automate it). The short of it is that Python builds are system agnostic while man pages are system specific. Also, if installed in a virtualenv, the manpage should not be installed (a reason they miss).

So if you are building deb/rmp/etc packages, then you can use click-man to generate the man page, It's just one more line in your build script. Or, if you installed MkDocs via pip and want a man page, you can pip install click-man and then run that one command manually.

Therefore, my proposed resolution of this issue is to document how to use click-man in the installation documentation and be done with it.

@waylan waylan added Documentation and removed Enhancement labels May 11, 2017

@d0ugal

This comment has been minimized.

Member

d0ugal commented May 11, 2017

👍🏼 great outcome.

waylan added a commit to waylan/mkdocs that referenced this issue Oct 5, 2017

@waylan waylan closed this in fc2f105 Jan 1, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment