History

Stephen Finucane 31f8ad4eb4 db: Enable auto-generation of database migrations Alembic does lots of new things. Provide docs for how to use this. This doesn't actually work that well at the moment because it appears our database migrations are not in sync with the models. Those issues will have to be resolved separately. Change-Id: I6645ca951114b94ce9ed5a83e5e11d53879a7cd5 Signed-off-by: Stephen Finucane <stephenfin@redhat.com>		2022-02-20 19:06:01 +00:00
..
ext	Make docs build parallel	2020-10-22 10:28:01 -05:00
source	db: Enable auto-generation of database migrations	2022-02-20 19:06:01 +00:00
test	docs: Rework and move upgrades guide	2022-02-20 19:06:00 +00: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	docs: Add whereto for testing redirect rules	2022-02-20 19:05:46 +00: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