mirror of
https://github.com/moby/moby.git
synced 2022-11-09 12:21:53 -05:00
Updated docs README with instructions to preview the generated manfile, and where to get the one generated by sphinx.
This commit is contained in:
parent
f4b63d9eea
commit
26229d78f2
1 changed files with 8 additions and 1 deletions
|
@ -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.
|
||||
* 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/
|
Loading…
Reference in a new issue