45b64631ee
The doc currently refers to an in-tree directory that we used to have in the distant past. Also link to config.py and the share backend feature support matrix where appropriate. Change-Id: Ic22eba0cedb7c6c7c89ef129a8c6a007d97c7e3b Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com> |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| README.rst | ||
| requirements.txt | ||
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.
- Graphviz
-
Some of the diagrams are generated using the
dotlanguage from Graphviz. See the Graphviz documentation for Graphviz and dot language usage information.
Building Documentation
Doc builds are performed using tox with the docs
target:
% cd ..
% tox -e docs