]> review.fuel-infra Code Review - openstack-build/cinder-build.git/commitdiff
Create a page of drivers with stevedore.sphinxext
authorCraige McWhirter <craige@mcwhirter.com.au>
Wed, 9 Sep 2015 02:01:32 +0000 (12:01 +1000)
committerCraige McWhirter <craige@mcwhirter.com.au>
Tue, 15 Sep 2015 05:54:34 +0000 (15:54 +1000)
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

doc/source/conf.py
doc/source/database_architecture.rst [new file with mode: 0644]
doc/source/drivers.rst [new file with mode: 0644]
doc/source/index.rst
doc/source/oslo-middleware.rst [new file with mode: 0644]
doc/source/scheduler-filters.rst [new file with mode: 0644]
doc/source/scheduler-weights.rst [new file with mode: 0644]

index d2ea1ceed66249b7c4e62139120abf37957e18fe..54a5be14639b82e31bc654109a5bea6626337531 100644 (file)
@@ -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
diff --git a/doc/source/database_architecture.rst b/doc/source/database_architecture.rst
new file mode 100644 (file)
index 0000000..9a63511
--- /dev/null
@@ -0,0 +1,9 @@
+==============================
+ Cinder Database Architecture
+==============================
+
+Cinder Database Backends
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. list-plugins:: cinder.database.migration_backend
+    :detailed:
diff --git a/doc/source/drivers.rst b/doc/source/drivers.rst
new file mode 100644 (file)
index 0000000..44ee4c2
--- /dev/null
@@ -0,0 +1,6 @@
+===================
+ Available Drivers
+===================
+
+.. list-plugins:: oslo_messaging.notify.drivers
+    :detailed:
index ef6dba4726fe5cd734cccf17bac4ea8466405c91..9044bedb05f07fb6f04aa9f8f5db65cda7d28415 100644 (file)
@@ -41,6 +41,11 @@ Developer Docs
    :maxdepth: 1
 
    devref/index
+   database_architecture
+   scheduler-filters
+   scheduler-weights
+   drivers
+   oslo-middleware
 
 API Extensions
 ==============
diff --git a/doc/source/oslo-middleware.rst b/doc/source/oslo-middleware.rst
new file mode 100644 (file)
index 0000000..60aa9ba
--- /dev/null
@@ -0,0 +1,6 @@
+==========================
+ Oslo Middleware
+==========================
+
+.. list-plugins:: oslo_middleware
+    :detailed:
diff --git a/doc/source/scheduler-filters.rst b/doc/source/scheduler-filters.rst
new file mode 100644 (file)
index 0000000..2bb153a
--- /dev/null
@@ -0,0 +1,6 @@
+==============================
+ Cinder Scheduler Filters
+==============================
+
+.. list-plugins:: cinder.scheduler.filters
+    :detailed:
diff --git a/doc/source/scheduler-weights.rst b/doc/source/scheduler-weights.rst
new file mode 100644 (file)
index 0000000..daeced7
--- /dev/null
@@ -0,0 +1,6 @@
+==========================
+ Cinder Scheduler Weights
+==========================
+
+.. list-plugins:: cinder.scheduler.weights
+    :detailed: