b1713e6255
This commit adds a new tox target to build PDF documentation. It's a community goal[0] to have PDF docs available. Also some minor fixes are needed for PDF: - Only show genindex and search for HTML. Theses elements do not make sense within PDF documents - Do not include full config sample files. This will not work and produces a "Dimension too large" error during the latex run. [0] https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Change-Id: I66b8c47d599c97e66c2ca76faa66204d5e7c9c3b
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