From 1b5f47414d24594dc5adc6a9b5c50c42e80b3f28 Mon Sep 17 00:00:00 2001
From: Craige McWhirter <craige@mcwhirter.com.au>
Date: Wed, 9 Sep 2015 12:01:32 +1000
Subject: [PATCH] Create a page of drivers with stevedore.sphinxext
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 | 1 +
doc/source/database_architecture.rst | 9 +++++++++
doc/source/drivers.rst | 6 ++++++
doc/source/index.rst | 5 +++++
doc/source/oslo-middleware.rst | 6 ++++++
doc/source/scheduler-filters.rst | 6 ++++++
doc/source/scheduler-weights.rst | 6 ++++++
7 files changed, 39 insertions(+)
create mode 100644 doc/source/database_architecture.rst
create mode 100644 doc/source/drivers.rst
create mode 100644 doc/source/oslo-middleware.rst
create mode 100644 doc/source/scheduler-filters.rst
create mode 100644 doc/source/scheduler-weights.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
index d2ea1ceed..54a5be146 100644
--- a/doc/source/conf.py
+++ b/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
diff --git a/doc/source/database_architecture.rst b/doc/source/database_architecture.rst
new file mode 100644
index 000000000..9a6351184
--- /dev/null
+++ b/doc/source/database_architecture.rst
@@ -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
index 000000000..44ee4c2ab
--- /dev/null
+++ b/doc/source/drivers.rst
@@ -0,0 +1,6 @@
+===================
+ Available Drivers
+===================
+
+.. list-plugins:: oslo_messaging.notify.drivers
+ :detailed:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index ef6dba472..9044bedb0 100644
--- a/doc/source/index.rst
+++ b/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
==============
diff --git a/doc/source/oslo-middleware.rst b/doc/source/oslo-middleware.rst
new file mode 100644
index 000000000..60aa9ba8e
--- /dev/null
+++ b/doc/source/oslo-middleware.rst
@@ -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
index 000000000..2bb153ab0
--- /dev/null
+++ b/doc/source/scheduler-filters.rst
@@ -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
index 000000000..daeced7e3
--- /dev/null
+++ b/doc/source/scheduler-weights.rst
@@ -0,0 +1,6 @@
+==========================
+ Cinder Scheduler Weights
+==========================
+
+.. list-plugins:: cinder.scheduler.weights
+ :detailed:
--
2.45.2