openstack/cinder
Code Issues Proposed changes
cinder/doc
History
Brian Rosmaita 98f08db858 Update driver removal policy 
This change follows the discussion of this issue at the 29 January
2020 Cinder weekly meeting.

Change-Id: I59d56889b28663a2248a7ba6cfad4f8260dfb9c8
2020-01-30 12:10:46 -05:00
..
ext
Launch driver list generation with the same python interpreter
2019-06-28 19:07:22 +02:00
source
Update driver removal policy
2020-01-30 12:10:46 -05: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
requirements.txt
Drop requirements for unsupported python versions
2020-01-02 14:55:25 -06: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