openstack/cinder
Code Issues Proposed changes
5540f1429a
cinder/doc
History
Ryan Liang 9e2f46a87d Fix tox docs failure 
doc/source/_static directory is required by oslo.policy sample generator.
_static directory is empty in the cinder repo but it must exist.
https://review.opendev.org/#/c/571106/ dropped doc/source/_static/.placeholder
accidentally. This commit recovers the place holder file to ensure
doc/source/_static directory exists.

Closes-bug: #1841131
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Ifad4371afa096afc2d0d71f6f077a53a9e52b60a
2019-08-23 15:08:33 +09:00
..
ext Launch driver list generation with the same python interpreter 2019-06-28 19:07:22 +02:00
source Fix tox docs failure 2019-08-23 15:08:33 +09: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