d560b1c465
Adds instructions on how to set up a fully functional manila development environment using Devstack to the Developers Reference. Partially-implements bp improve-manila-developer-docs Change-Id: Id9781046716af2e04a0aea2734fbe4590bfd28dc
Manila Development Docs
Files under this directory tree are used for generating the documentation for the manila source code.
Developer documentation is built to: http://docs.openstack.org/developer/manila/
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