History

zhangbailin 234a0784bf Replace http with https for doc links in cinder 1) Update doc links according to OpenStack document migration 2) Use https instead of http for docs links For example: (1)http://docs.openstack.org/admin-guide/blockstorage_nfs_backend.html ->https://docs.openstack.org/cinder/latest/admin/blockstorage-nfs-backend.html (2)http://docs.openstack.org/oslo.i18n/latest/user/index.html ->https://docs.openstack.org/oslo.i18n/latest/user/index.html (3)http://docs.openstack.org/ --> https://docs.openstack.org/ (4)http://docs.openstack.org/admin-guide/blockstorage_multi_backend.html ->https://docs.openstack.org/cinder/latest/admin/blockstorage-multi-backend.html Change-Id: I7fcdc4453cb3bad713c7d770012411701cca742b Closes-Bug:#1710054		2017-10-17 11:14:01 +08:00
..
ext	Add Apache 2.0 license to source file	2016-12-14 02:17:04 +00:00
source	Replace http with https for doc links in cinder	2017-10-17 11:14:01 +08: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
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

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