Unverified Commit fc2f105b authored by Waylan Limberg's avatar Waylan Limberg Committed by GitHub
Browse files

Document how to generate/install manpages. (#1302)

Fixes #686.
parent 8d4a883d
......@@ -118,6 +118,19 @@ $ mkdocs --version
mkdocs, version 0.15.3
```
!!! Note
If you would like manpages installed for MkDocs, the [click-man] tool can
generate and install them for you. Simply run the following two commands:
pip install click-man
click-man --target path/to/man/pages mkdocs
See the [click-man documentation] for an explaination of why manpages are
not automaticaly generated and installed by pip.
[click-man]: https://github.com/click-contrib/click-man
[click-man documentation]: https://github.com/click-contrib/click-man#automatic-man-page-installation-with-setuptools-and-pip
!!! Note
If you are using Windows, some of the above commands may not work
out-of-the-box.
......@@ -344,4 +357,4 @@ the MkDocs IRC channel `#mkdocs` on freenode.
[pip]: http://pip.readthedocs.io/en/stable/installing/
[Python]: https://www.python.org/
[site_name]: user-guide/configuration/#site_name
[theme]: user-guide/configuration/#theme
\ No newline at end of file
[theme]: user-guide/configuration/#theme
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment