p4u1/docker-cli
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
Upstream-commit: 26229d78f2b77592ab6761a4ffce38ab7d859f3b
Component: engine
This commit is contained in:
Thatcher Peskens
2013-07-31 13:44:10 -07:00
parent 2ad5267228
commit 0a6a10bae5
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
components/engine/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/