cinder/doc/source/contributor/cinder.rst
Jay S. Bryant 1423480fb6 Make doc/source directory compliant with design in spec
The following spec defines what each project's doc/source
directory is supposed to look like:

https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html

I had not yet moved existing content to follow this design.
This patch does that, moving the devref to the
'contributor' directory.  It also moves the CLI
related documentation into the 'cli' directory.  I have
updated the autodoc generation to now create the api
documentation in 'doc/source/contributor/api'.

This patch also creates a template for future documentation
contribution.  I have created all of the directories
recommended by the spec and have included documentation
as to what should go in each directory.

The index file is updated to point at the new locations for
existing content.

'doc/.gitignore' is updated so that it won't complain about the
automatically generated 'doc/contributor/api' directory.

Change-Id: I55c50fa0b7c1d06c91e40dbcfd11b1c8e8378aa6
2017-07-19 15:59:02 -05:00

2.4 KiB

Common and Misc Libraries

Libraries common throughout Cinder or just ones that haven't been categorized very well yet.

The cinder.context Module

cinder.context

The cinder.exception Module

cinder.exception

The cinder.common.config Module

cinder.common.config

The cinder.rpc Module

cinder.rpc

The cinder.test Module

cinder.test

The cinder.utils Module

cinder.utils

The cinder.wsgi Module

cinder.wsgi

Tests

The conf_fixture Module

cinder.tests.unit.conf_fixture

The test_rpc Module

cinder.tests.unit.test_rpc