History

Lucian Petrut 8fe26313c6 Update Windows docs

This change updates the Cinder Volume install guide, targeting
Windows deployments.

The Windows iSCSI driver doc has been updated. The Windows SMB
driver was undocumented, which is also addressed by this change.

Closes-Bug: #1746022

Change-Id: I46fadc8df59f7203bc3445c24d3bd6547275ee5b

2018-01-30 20:15:23 +02:00

ext

Add Apache 2.0 license to source file

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

source

Update Windows docs

2018-01-30 20:15:23 +02: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

Updated from global requirements

2018-01-17 20:29:25 +00: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