openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Brian Rosmaita 3e607f1d87 Update doc contributor doc 
Update some of the information for documentation contributors and
correct some formatting.

Change-Id: Ib22c8ca5b5ea98a95ee435c242435310fe3dcb0c
 		2020-11-16 10:07:17 -05:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Update doc contributor doc 2020-11-16 10:07:17 -05:00
.gitignore Make doc/source directory compliant with design in spec 2017-07-19 15:59:02 -05:00
README.rst Update and replace http with https for doc links in Cinder 2017-07-27 09:58:23 +00:00
requirements.txt Make docs build parallel 2020-10-22 10:28:01 -05:00

README.rst

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