manila/doc/README.rst

34 lines
865 B
ReStructuredText
Raw Normal View History

=======================
Manila Development Docs
=======================
2013-08-08 14:34:06 +00:00
Files under this directory tree are used for generating the documentation
for the manila source code.
2013-08-08 14:34:06 +00:00
Developer documentation is built to:
https://docs.openstack.org/manila/latest/
2013-08-08 14:34:06 +00:00
Tools
=====
2013-08-08 14:34:06 +00: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/>`_.
2013-08-08 14:34:06 +00:00
Graphviz
2013-08-08 14:34:06 +00: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.
2013-08-08 14:34:06 +00:00
Building Documentation
======================
2013-08-08 14:34:06 +00:00
Doc builds are performed using tox with the ``docs`` target::
2013-08-08 14:34:06 +00:00
% cd ..
% tox -e docs
2013-08-08 14:34:06 +00:00