openstack/cinder
Code Issues Proposed changes
f53b4204e3
cinder/doc
History
Andreas Jaeger 112e8a9a43 Change PDF file name 
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.

Follow this rename.

Change-Id: I859b38b139a37cb092b5d6c11998b7400613c342
2019-09-04 06:49:30 +02:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Change PDF file name 2019-09-04 06:49:30 +02: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 Update docs building 2019-08-10 11:41:14 +02: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