History

Update install docs to match default NFS config

nfs_shares_config default is "nfs_shares" but install doc instructed to
use "nfsshares". Following the documented instructions would work, but
we should use the default config value.

Closes-bug: #1716987

Change-Id: Ia5fb7a43cd47ed8fdd3e561affd9c3af95e6b40b
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>

2019-02-05 15:09:44 -06:00

ext

Update sphinx extension logging

2018-10-16 15:19:03 -05:00

source

Update install docs to match default NFS config

2019-02-05 15:09:44 -06: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