cinder/doc/README.rst
Sean McGinnis 8d9cad38e4 Update doc README and remove old Makefile
The information in the README file in the doc directory was very out of
date and the Makefile referenced in it doesn't appear to work any more.

Our preferred doc build method is to stay consistent with using tox -e docs,
so removing the legacy build information and providing better details for
doc development.

Change-Id: Ifd01b9cfc39fe99697a1669ecb5db6302359b662
2016-07-23 18:04:04 -05:00

34 lines
868 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