openstack/cinder
Code Issues Proposed changes
b7d751ad2d
cinder/doc
History
TommyLike e5c45ffbaf [BugFix][Devref] Refactor attach/detach v2 devref 
There are some issues around new attach/detach APIs/CLIs,
fix them step by step. Currently the attach/detach dev ref
is out of date and have some format issues.
Refactor attach/detach v2 devref to make it
more readable. This is the original version: [1]

DocImpact
Depends-On: bae8bd017e30425295e03d13b39202a81e923c3e
Closes-Bug: 1675976
[1] https://docs.openstack.org/developer/cinder/devref/attach_detach_conventions_v2.html

Change-Id: I26f8427b38ee08c5da7224df6423956ee9a744d2
2017-03-28 21:53:18 +08:00
..
ext Add Apache 2.0 license to source file 2016-12-14 02:17:04 +00:00
source [BugFix][Devref] Refactor attach/detach v2 devref 2017-03-28 21:53:18 +08:00
.gitignore Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
find_autodoc_modules.sh Fixes a small issue in find_autodoc_modules.sh 2015-01-23 14:38:44 +08:00
generate_autodoc_index.sh Initial fork out of Nova. 2012-05-03 10:48:26 -07:00
README.rst doc: verify all rst files 2017-02-14 12:36:57 +01: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: http://docs.openstack.org/developer/cinder/

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