openstack/cinder
Code Issues Proposed changes

Create a page of drivers with stevedore.sphinxext

Browse Source 
As per:
http://lists.openstack.org/pipermail/openstack-dev/2015-August/073338.html

The point behind the addition of the stevedore.sphinxext extension is
"to document drivers and other types of plugins to make the available
sets built into projects easier to discover" (dhellman).

Change-Id: I8427398e8d01c36f346e493a8144c1012ca7c5bf
This commit is contained in:
Craige McWhirter 2015-09-09 12:01:32 +10:00
parent bcc7ce05cb
commit 1b5f47414d
7 changed files with 39 additions and 0 deletions

1
doc/source/conf.py

@ -33,6 +33,7 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.ifconfig',
'sphinx.ext.graphviz',
'oslosphinx',
'stevedore.sphinxext'
]
# autodoc generation is a bit aggressive and a nuisance

9
doc/source/database_architecture.rst Normal file

@ -0,0 +1,9 @@
==============================
Cinder Database Architecture
==============================
Cinder Database Backends
~~~~~~~~~~~~~~~~~~~~~~~~
.. list-plugins:: cinder.database.migration_backend
:detailed:

6
doc/source/drivers.rst Normal file

@ -0,0 +1,6 @@
===================
Available Drivers
===================
.. list-plugins:: oslo_messaging.notify.drivers
:detailed:

5
doc/source/index.rst

@ -41,6 +41,11 @@ Developer Docs
:maxdepth: 1
devref/index
database_architecture
scheduler-filters
scheduler-weights
drivers
oslo-middleware
API Extensions
==============

6
doc/source/oslo-middleware.rst Normal file

@ -0,0 +1,6 @@
==========================
Oslo Middleware
==========================
.. list-plugins:: oslo_middleware
:detailed:

6
doc/source/scheduler-filters.rst Normal file

@ -0,0 +1,6 @@
==============================
Cinder Scheduler Filters
==============================
.. list-plugins:: cinder.scheduler.filters
:detailed:

6
doc/source/scheduler-weights.rst Normal file

@ -0,0 +1,6 @@
==========================
Cinder Scheduler Weights
==========================
.. list-plugins:: cinder.scheduler.weights
:detailed: