openstack/cinder
Code Issues Proposed changes
88b993b192
cinder/doc
History
Brian Rosmaita 58b193887a Remove sample policy config from docs generation 
Everything is fine for HTML, but something here is causing a problem
for the PDF build, which is causing the openstack-tox-docs job to
fail, and is blocking the gate.

We can revert this patch when we figure out what's going on.

Change-Id: Ic752048b3a1f87a95e51df43b6c86b571098ecea
2021-09-14 14:03:58 -04:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Remove sample policy config from docs generation 2021-09-14 14:03:58 -04: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 Use os-brick 4.3.0 2021-03-25 13:15:43 -04: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