e3e749fa30
Make use of doc8 to verify all rst files which are not autogenerated for errors and fail if there are any issues found. The doc8 checks are now part of the tox 'docs' environment and ran automatically. Checks can also be called direcly via 'tox -e docs'. Fix all issues found by doc8. Closes-Bug: #1566765 Change-Id: I2b25247030a1aadcfe029c9e071ef17f2f72046b Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
34 lines
867 B
ReStructuredText
34 lines
867 B
ReStructuredText
=======================
|
|
Cinder Development Docs
|
|
=======================
|
|
|
|
Files under this directory tree are used for generating the documentation
|
|
for the Cinder source code.
|
|
|
|
Developer documentation is built to:
|
|
http://docs.openstack.org/developer/cinder/
|
|
|
|
Tools
|
|
=====
|
|
|
|
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/>`_.
|
|
|
|
Graphviz
|
|
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.
|
|
|
|
|
|
Building Documentation
|
|
======================
|
|
|
|
Doc builds are performed using tox with the ``docs`` target::
|
|
|
|
% cd ..
|
|
% tox -e docs
|
|
|