e89dfb0eab
- cinder-manage shell - cinder-manage shell bpython - cinder-manage shell ipython - cinder-manage shell python - cinder-manage shell run - cinder-manage shell script These aren't maintained and don't serve any particular purpose in a Cinder deployment. Remove them. Change-Id: I61effa4a7141617ad6971597e9d1d167a4758a5c
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
dot
language 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