e68d33ef68
This updates our thread extension and tox command for docs builds to use the available number of cores to multithread the docs build. This can speed things up significantly. Depends-on: https://review.opendev.org/741026 Change-Id: I1ba656390094b4e1c6d3fb7bb3028eadb11c4d08 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: https://docs.openstack.org/cinder/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