e1b9241384
This should help new contributors have an easier on-ramp to certain kinds of manila development. Change-Id: I55a43cccec2f8a1987042398c9f8057a95f44d8f Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
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
dot
language 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