Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx.

This commit is contained in:
Thatcher Peskens 2013-07-31 13:44:10 -07:00 committed by Tibor Vass
parent 77926c6033
commit 9c5f4391e1
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/README.md
View File

@ -74,5 +74,12 @@ Guides on using sphinx
Start without $, so it's easy to copy and paste.
Manpages
--------
* To make the manpages, simply run 'make man'. Pleae note there is a bug in spinx 1.1.3 which makes this fail.
Upgrade to the latest version of sphinx.
Upgrade to the latest version of sphinx.
* Then preview the manpage by running `man _build/man/docker.1`, where _build/man/docker.1 is the path to the generated
manfile
The manpages are also autogenerated by our hosted readthedocs here: http://docs-docker.dotcloud.com/projects/docker/downloads/