de219b7134
The configuration, admin and install guides had pointers to content that didn't get brought over from openstack-manuals. This patch addresses that missing content. The install guides ad a number of places where it referenced the OpenStack Overview content which seemed reasonable to make available in our documentation for reference. I brought along associated figures that support that documentation. The windows-iscsi-volume-driver documentation had pointers to content in the compute/hypervisor documentation that haven't and may not be migrated. I pulled the two sections being referenced into the rst file in Cinder. The reference in blockstorage-manage-volumes to networking was changed to use a link to the Neutron documentation. This eliminates all the Sphinx warnings generated around missing links to documentation. Change-Id: I85ad0207ae480d499a34d273895b6a88fb41fda7
Cinder Development Docs
Files under this directory tree are used for generating the documentation for the Cinder source code.
Developer documentation is built to: http://docs.openstack.org/developer/cinder/
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