openstack/cinder
Code Issues Proposed changes
b389c18bd6
cinder/doc
History
Brian Rosmaita d40b0b8b51 Make policy config docs consistent 
The RST file introducing the sample policy file in the docs directory
has gotten out of sync with etc/cinder/README-policy.generate.md

Change-Id: Ic43c631bb7af0b4d888e539d4ca50e379f693b3c
Partial-bug: #1805550
2018-12-10 13:08:46 +00:00
..
ext Update sphinx extension logging 2018-10-16 15:19:03 -05:00
source Make policy config docs consistent 2018-12-10 13:08:46 +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 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