openstack/cinder
Code Issues Proposed changes
fbe956590c
cinder/doc
History
Niklas Schwarz fbe956590c Remove unsupported options from cinder-manage quota command 
The documentation of the cinder-manage quota check and
cinder-manage quota sync command list an option which are
not supported by the commands.

This patch will remove the unsupported options from the documentation
and adjust the documentation accordingly.

Related Bug: #1991217

Change-Id: I87a67474c7a4dbf83fc950169959fe03476ab48d
2022-09-29 10:18:26 +02:00
..
ext Make docs build parallel 2020-10-22 10:28:01 -05:00
source Remove unsupported options from cinder-manage quota command 2022-09-29 10:18:26 +02:00
test docs: Remove unnecessary 'blockstorage-' prefix 2022-02-20 19:06:32 +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

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