1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
=======================
Manila Development Docs
=======================
Files under this directory tree are used for generating the documentation
for the manila source code.
Developer documentation is built to:
https://docs.openstack.org/manila/latest/
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
|
