openstack/cinder
Code Issues Proposed changes
ec030ad063
cinder/doc
History
zhangxiaofan02 50bcacee80 Fix a typo error in explanatory notes 
This patch changes " running nigthly"
to " running nightly" at the 137 line
in cinder/doc/source/contributor/gerrit.rst

Closes-Bug: #1952683
Change-Id: Ia6ac8cb0b458b6b828c5a54f0475c05d940e93e1
2021-11-30 16:40:38 +08:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Fix a typo error in explanatory notes 2021-11-30 16:40:38 +08: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