8f69ccbb2f
The docs job is currently broken, as two warnings are currently being treated as errors. It is happening because we are adding some references to the footnote but we are not actually referencing them in the text. Fixed that by removing one obsolete mention and adding the pending mentions. Change-Id: Ib636be308144d226cd54893e4248c85d7355ddf4 Signed-off-by: Carlos Eduardo <ces.eduardo98@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
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