openstack/cinder
Code Issues Proposed changes
409e9796f0
cinder/doc
History
Sean McGinnis 409e9796f0
Restructure Huawei driver 
As part of further refactoring work, this pulls out common driver code
into its own file to better organize the code.

Change-Id: Ib5b52b638e27743d86106cc9859f8adeab2aab08
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2018-10-16 15:00:16 -05:00
..
ext Merge "Add skip filter to config-table directive" 2018-05-18 04:23:41 +00:00
source Restructure Huawei driver 2018-10-16 15:00:16 -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 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