README.rst
1=======================
2Cinder Development Docs
3=======================
4
5Files under this directory tree are used for generating the documentation
6for the Cinder source code.
7
8Developer documentation is built to:
9https://docs.openstack.org/cinder/latest/
10
11Tools
12=====
13
14Sphinx
15 The Python Sphinx package is used to generate the documentation output.
16 Information on Sphinx, including formatting information for RST source
17 files, can be found in the
18 `Sphinx online documentation <http://www.sphinx-doc.org/en/stable/>`_.
19
20Graphviz
21 Some of the diagrams are generated using the ``dot`` language
22 from Graphviz. See the `Graphviz documentation <http://www.graphviz.org/>`_
23 for Graphviz and dot language usage information.
24
25
26Building Documentation
27======================
28
29Doc builds are performed using tox with the ``docs`` target::
30
31 % cd ..
32 % tox -e docs
33
34