History

Rajat Dhasmana e95754147d Fix pep8 issues in driver docs

I noticed these pep8 failures that are unrelated to my patch

...block-storage/drivers/dell-emc-vnx-driver.rst:1083: D001 Line too long
...block-storage/drivers/hpe-3par-driver.rst:348: D001 Line too long

Patch: https://review.opendev.org/c/openstack/cinder/+/823089
Job: https://storage.gra.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_824/823089/8/check/openstack-tox-pep8/824f11a/job-output.txt

Looks no harm in fixing them.

Change-Id: I6b0186740540bab728f9e0874de4defa4c42fec8

2024-09-03 10:30:23 +05:30

ext

Make docs build parallel

2020-10-22 10:28:01 -05:00

source

Fix pep8 issues in driver docs

2024-09-03 10:30:23 +05:30

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