042f7173f9
1. doc/source/_static will be auto generated when build docs and usually cause difference with the original one after doc building. 2. manila/doc/.gitignore file is unnecessary because manila/.gitignore already ignore the doc/build directory. 3. add git ignore of doc/source/_static in manila/.gitignore Change-Id: Ibf13e08f0b0b57718d453ee3240d30124940b521 |
||
|---|---|---|
| .. | ||
| ext | ||
| source | ||
| README.rst | ||
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