History

wanghao c862e5d934 Adding all docs into index.rst of administration docs

There is only four docs ref in index.rst of administration
docs. It's not convenient for users to look for other
administration docs.

This patch will add all other docs into it.

Change-Id: Ie93c608b40968f07cbb17ec40cd22e52120fd396
Closes-Bug: #1739988

2017-12-25 11:10:33 +08:00

ext

Add Apache 2.0 license to source file

2016-12-14 02:17:04 +00:00

source

Adding all docs into index.rst of administration docs

2017-12-25 11:10:33 +08:00

.gitignore

Make doc/source directory compliant with design in spec

2017-07-19 15:59:02 -05: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

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

Follow the new PTI for document build

2017-12-20 18:24:11 -08: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