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

Some more improvements on the docs readme. Removed references to website.

This commit is contained in:
Thatcher 2013-07-31 13:59:56 -07:00 committed by Tibor Vass
parent 9c5f4391e1
commit 2216afb617
1 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/README.md
View File

@ -1,14 +1,12 @@
Docker documentation and website Docker Documentation
================================ ====================
Documentation Documentation
------------- -------------
This is your definite place to contribute to the docker documentation. The documentation is generated from the This is your definite place to contribute to the docker documentation. After each push to master the documentation
.rst files under sources. is automatically generated and made available on [docs.docker.io](http://docs.docker.io)
The folder also contains the other files to create the http://docker.io website, but you can generally ignore
most of those.
Each of the .rst files under sources reflects a page on the documentation.
Installation Installation
------------ ------------
@ -36,13 +34,11 @@ Images
------ ------
When you need to add images, try to make them as small as possible (e.g. as gif). When you need to add images, try to make them as small as possible (e.g. as gif).
Notes Notes
----- -----
* For the template the css is compiled from less. When changes are needed they can be compiled using * 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`` lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css``
Guides on using sphinx Guides on using sphinx
---------------------- ----------------------
* To make links to certain pages create a link target like so: * To make links to certain pages create a link target like so:
@ -77,9 +73,8 @@ Guides on using sphinx
Manpages 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'. Please 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 * Then preview the manpage by running `man _build/man/docker.1`, where _build/man/docker.1 is the path to the generated
manfile manfile
* The manpages are also autogenerated by our hosted readthedocs here: http://docs-docker.dotcloud.com/projects/docker/downloads/
The manpages are also autogenerated by our hosted readthedocs here: http://docs-docker.dotcloud.com/projects/docker/downloads/