History

Sean McGinnis 25ec787557 Update HPE docs to use config-table directive

Remove use of static config tables in favor of dynamically
generated ones using the config-table directive.

Change-Id: I886a1a3c44262b6ba49ffa9295067cb2db148c4b

2018-05-02 15:56:16 +00:00

ext

Add config table sphinx directive

2018-04-26 13:47:43 -05:00

source

Update HPE docs to use config-table directive

2018-05-02 15:56:16 +00: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

Use sphinxcontrib.apidoc for module docs

2018-04-05 14:36:03 -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