Browse Source

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

Thatcher Peskens 12 years ago
parent
commit
26229d78f2
1 changed files with 8 additions and 1 deletions
  1. 8 1
      docs/README.md

+ 8 - 1
docs/README.md

@@ -74,5 +74,12 @@ Guides on using sphinx
 
 
   Start without $, so it's easy to copy and paste.
   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.
 * 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/