openstack/cinder
Code Issues Proposed changes
0d88d72362
cinder/doc
History
Michał Dulko 619d28bc45 Remove driver interface changes from reno devref 
Updating reno guideline in devref to reflect latest discussion at the
IRC meeting:

<smcginnis> We really only need release notes for things that would be
good to tell deployers and end users.
<smcginnis> Internal technical details would just be confusing to most
of them, so they definitely should not have a RL.

This commit removes the line stating that we should add a release note
with the driver interfaces changes.

Change-Id: Ibcca37c85e544aa7783bc08cefd1833af87acd5d
2016-09-09 10:28:37 +02:00
..
ext Merge "Add driver list to doc build" 2016-07-29 02:24:22 +00:00
source Remove driver interface changes from reno devref 2016-09-09 10:28:37 +02: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 Update doc README and remove old Makefile 2016-07-23 18:04: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: 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