70ecf89cd9
These doc enhancements still use the "manila" CLI/shell utility. It makes it easier to backport to older branches. A future commit will update all documentation to use OSC. Change-Id: I18c4ac2d4134314da9df0d3e0b7d45acafce2b22 Closes-Bug: #1941057 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