openstack
/
cinder
Code Issues Proposed changes
cinder/doc
History
Xing Zhang 5ead630429
Fix cinder-manage args --max_count in docs 
--max_count was added in [0]

[0] https://review.openstack.org/#/c/330391/

Change-Id: If3780b4ec799ff244f02182b636a7afe4037445b
 		2019-04-12 16:06:04 +08:00
..
ext Use config-table for dynamic config documentation 2019-02-26 16:50:39 -06:00
source Fix cinder-manage args --max_count in docs 2019-04-12 16:06:04 +08: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 Move sphinx-feature-classification to docs reqs 2018-08-30 13:37:04 -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