34 lines
865 B
ReStructuredText
Raw Normal View History

=======================
Cinder Development Docs
=======================
2012-05-03 10:48:26 -07:00
Files under this directory tree are used for generating the documentation
for the Cinder source code.
2012-05-03 10:48:26 -07:00
Developer documentation is built to:
https://docs.openstack.org/cinder/latest/
2012-05-03 10:48:26 -07:00
Tools
=====
2012-05-03 10:48:26 -07:00
Sphinx
The Python Sphinx package is used to generate the documentation output.
Information on Sphinx, including formatting information for RST source
files, can be found in the
`Sphinx online documentation <http://www.sphinx-doc.org/en/stable/>`_.
2012-05-03 10:48:26 -07:00
Graphviz
2012-05-03 10:48:26 -07:00
Some of the diagrams are generated using the ``dot`` language
from Graphviz. See the `Graphviz documentation <http://www.graphviz.org/>`_
for Graphviz and dot language usage information.
2012-05-03 10:48:26 -07:00
Building Documentation
======================
2012-05-03 10:48:26 -07:00
Doc builds are performed using tox with the ``docs`` target::
% cd ..
% tox -e docs