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

Enabled the docs to generate manpages.

Browse Source 
* changed conf.py to reference toctree.rst instead of index
* Added note to README to upgrade your sphinx to the latest version to prevent a bug with .. note:: blocks.
Upstream-commit: 77926c6033
Component: cli
This commit is contained in:
Thatcher Peskens
2013-07-25 17:19:58 -07:00
committed by Tibor Vass
parent 99a1852177
commit cdc3377009
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
components/cli/docs/README.md
View File

@ -39,8 +39,6 @@ When you need to add images, try to make them as small as possible (e.g. as gif)
Notes
-----
* The index.html and gettingstarted.html files are copied from the source dir to the output dir without modification.
So changes to those pages should be made directly in html
* For the template the css is compiled from less. When changes are needed they can be compiled using
lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css``
@ -75,3 +73,6 @@ Guides on using sphinx
* Code examples
Start without $, so it's easy to copy and paste.
* 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.