The HTML files are built and hosted on readthedocs.org, appearing via proxy on https://docs.docker.io. The HTML files update automatically after each change to the master or release branch of the docker files on GitHub thanks to post-commit hooks. The “release” branch maps to the “latest” documentation and the “master” branch maps to the “master” documentation.
Warning: The “master” documentation may include features not yet part of any official docker release. “Master” docs should be used only for understanding bleeding-edge development and “latest” should be used for the latest official release.
If you need to manually trigger a build of an existing branch, then you can do that through the readthedocs interface. If you would like to add new build targets, including new branches or tags, then you must contact one of the existing maintainers and get your readthedocs.org account added to the maintainers list, or just file an issue on GitHub describing the branch/tag and why it needs to be added to the docs, and one of the maintainers will add it for you.
To edit and test the docs, you'll need to install the Sphinx tool and its dependencies. There are two main ways to install this tool:
Install dependencies from
requirements.txt file in your
pip install -r docs/requirements.txt
Mac OS X:
[sudo] pip-2.7 install -r docs/requirements.txt
###Alternative Installation: Docker Container
If you're running
docker on your development machine then you may find it easier and cleaner to use the docs Dockerfile. This installs Sphinx in a container, adds the local
docs/ directory and builds the HTML docs inside the container, even starting a simple HTTP server on port 8000 so that you can connect and see your changes.
docker source directory, run:
This is the equivalent to
make clean server since each container starts clean.
.rstfiles with your favorite editor -- try to keep the lines short and respect RST and Sphinx conventions.
make clean docsto clean up old files and generate new ones, or just
make docsto update after small changes.
make serverand open http://localhost:8000/ in your favorite browser.
make clean docs must complete without any warnings or errors.
Alternatively, for small changes and typos you might want to use GitHub's built in file editor. It allows you to preview your changes right online (though there can be some differences between GitHub markdown and Sphinx RST). Just be careful not to create many commits.
When you need to add images, try to make them as small as possible (e.g. as gif). Usually images should go in the same directory as the .rst file which references them, or in a subdirectory if one already exists.
lessc main.lessor watched using watch-lessc
watch-lessc -i main.less -o main.css
To make links to certain sections create a link target like so:
.. _hello_world: Hello world =========== This is.. (etc.)
_hello_world: will make it possible to link to this position (page and section heading) from all other pages. See the Sphinx docs for more information and examples.
Notes, warnings and alarms
# a note (use when something is important) .. note:: # a warning (orange) .. warning:: # danger (red, use sparsely) .. danger::
$(dollar space) so that they are easily differentiated from program output.
make man. Please note there is a bug in Sphinx 1.1.3 which makes this fail. Upgrade to the latest version of Sphinx.
man _build/man/docker.1, where
_build/man/docker.1is the path to the generated manfile