
As those files are not referenced anywhere within this repository we can get rid of them. This is a follow up of the findings during the review of https://review.opendev.org/#/c/687491/ Change-Id: Ic2d5e52a7c8b8cf2f230f6a2b440d29ebb6de3f5
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