History

Helen Walsh e7e2d3f624 VMAX driver - Pike documentation amendments

VMAX driver documentation amendments.

Change-Id: I477c351ce65e9ff5754998683bf22525530b6421
Closes-Bug: #1708481

2017-08-30 11:56:15 +01:00

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

2017-08-30 11:56:15 +01:00

.gitignore

2017-07-19 15:59:02 -05:00

find_autodoc_modules.sh

2015-01-23 14:38:44 +08:00

generate_autodoc_index.sh

2017-07-19 15:59:02 -05:00

README.rst

doc: verify all rst files

2017-02-14 12:36:57 +01: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