History

Sean McGinnis 8c6355f3cc Add upgrade check for presence of policy.json file Correct file is policy.yaml and only needed if overriding defaults. This only warns if the file is present in case it was left by a previous version and not actually needed or used. Also checks for the policy_file being overridden in config, and if so, warns if the specified file does not exist. Change-Id: Ia46e843ad245cf8263b97b773fac9bc6c6fe6647 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>		2019-04-04 13:59:13 -05:00
..
ext	Use config-table for dynamic config documentation	2019-02-26 16:50:39 -06:00
source	Add upgrade check for presence of policy.json file	2019-04-04 13:59:13 -05: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

Cinder Development Docs

Files under this directory tree are used for generating the documentation for the Cinder source code.

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.

Doc builds are performed using tox with the docs target:

% cd ..
% tox -e docs