78fa04624d
Our installation guide walks through configuring storage nodes using the LVM driver. LVM now defaults to thinly provisioned, which requires thing-provisioning-tools to be installed on the host. So by default, our instructions will result in failure when we attempt to perform thin provision operations. This adds mention of installing the required package for each platform's instructions to get the necessary tools installed. It also adds device-mapper-persistent-data to bindep for Red Hat based platforms to get those thin provisioning tools that were previously missing for these platforms. Tools appear to be installed by default on Suse platforms. Change-Id: I2a84ae99d71c3551814197917d114057430858b7 Closes-bug: #1738409
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
dotlanguage 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