History

ashish.billore 9dc4c8704e Cinder tox updates for Python3

Fix the Sphinx html_last_updated_fmt for Python3.
The html_last_updated_fmt option is interpeted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I24f83aa15cd4301aac9a7a941fe7d4c1e497c46e
Closes-Bug: #1659390
Signed-off-by: ashish.billore <ashish.billore@gmail.com>

2017-02-13 23:21:31 +09:00

ext

Add Apache 2.0 license to source file

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

source

Cinder tox updates for Python3

2017-02-13 23:21:31 +09:00

.gitignore

Initial fork out of Nova.

2012-05-03 10:48:26 -07: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

Initial fork out of Nova.

2012-05-03 10:48:26 -07:00

README.rst

Update doc README and remove old Makefile

2016-07-23 18:04: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: http://docs.openstack.org/developer/cinder/

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