summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-07-06 03:34:12 +0000
committerGerrit Code Review <review@openstack.org>2017-07-06 03:34:12 +0000
commitb36cfac52531c663ec5f137ecceb7f348caf1a1b (patch)
tree3d2316bf98c29c288b0c2bf1fe1a8d8dc22c3239
parente432fac63bfd851128b6771aacf91a1b511b2d1f (diff)
parent280cb368f71c9b5355fb3e52d68263cc886262a1 (diff)
downloadoslo-messaging-b36cfac52531c663ec5f137ecceb7f348caf1a1b.tar.gz
Merge "rearrange content to fit the new standard layout"
-rw-r--r--doc/source/admin/AMQP1.0.rst (renamed from doc/source/AMQP1.0.rst)0
-rw-r--r--doc/source/admin/drivers.rst (renamed from doc/source/drivers.rst)0
-rw-r--r--doc/source/admin/index.rst11
-rw-r--r--doc/source/admin/pika_driver.rst (renamed from doc/source/pika_driver.rst)0
-rw-r--r--doc/source/admin/zmq_driver.rst (renamed from doc/source/zmq_driver.rst)0
-rw-r--r--doc/source/conf.py2
-rw-r--r--doc/source/configration/conffixture.rst (renamed from doc/source/conffixture.rst)0
-rw-r--r--doc/source/configration/index.rst9
-rw-r--r--doc/source/configration/opts.rst (renamed from doc/source/opts.rst)0
-rw-r--r--doc/source/contributor/contributing.rst (renamed from doc/source/contributing.rst)2
-rw-r--r--doc/source/contributor/driver-dev-guide.rst (renamed from doc/source/driver-dev-guide.rst)0
-rw-r--r--doc/source/contributor/index.rst10
-rw-r--r--doc/source/contributor/supported-messaging-drivers.rst (renamed from doc/source/supported-messaging-drivers.rst)0
-rw-r--r--doc/source/index.rst28
-rw-r--r--doc/source/reference/exceptions.rst (renamed from doc/source/exceptions.rst)0
-rw-r--r--doc/source/reference/executors.rst (renamed from doc/source/executors.rst)0
-rw-r--r--doc/source/reference/index.rst19
-rw-r--r--doc/source/reference/notification_driver.rst (renamed from doc/source/notification_driver.rst)0
-rw-r--r--doc/source/reference/notification_listener.rst (renamed from doc/source/notification_listener.rst)0
-rw-r--r--doc/source/reference/notifier.rst (renamed from doc/source/notifier.rst)0
-rw-r--r--doc/source/reference/rpcclient.rst (renamed from doc/source/rpcclient.rst)0
-rw-r--r--doc/source/reference/serializer.rst (renamed from doc/source/serializer.rst)0
-rw-r--r--doc/source/reference/server.rst (renamed from doc/source/server.rst)0
-rw-r--r--doc/source/reference/target.rst (renamed from doc/source/target.rst)0
-rw-r--r--doc/source/reference/transport.rst (renamed from doc/source/transport.rst)0
-rw-r--r--doc/source/static/.placeholder0
-rw-r--r--doc/source/user/FAQ.rst (renamed from doc/source/FAQ.rst)0
-rw-r--r--doc/source/user/history.rst1
-rw-r--r--doc/source/user/index.rst13
29 files changed, 71 insertions, 24 deletions
diff --git a/doc/source/AMQP1.0.rst b/doc/source/admin/AMQP1.0.rst
index 3723b00..3723b00 100644
--- a/doc/source/AMQP1.0.rst
+++ b/doc/source/admin/AMQP1.0.rst
diff --git a/doc/source/drivers.rst b/doc/source/admin/drivers.rst
index 21b021a..21b021a 100644
--- a/doc/source/drivers.rst
+++ b/doc/source/admin/drivers.rst
diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst
new file mode 100644
index 0000000..d032aaf
--- /dev/null
+++ b/doc/source/admin/index.rst
@@ -0,0 +1,11 @@
+================
+Deployment Guide
+================
+
+.. toctree::
+ :maxdepth: 2
+
+ drivers
+ AMQP1.0
+ pika_driver
+ zmq_driver
diff --git a/doc/source/pika_driver.rst b/doc/source/admin/pika_driver.rst
index b89fabd..b89fabd 100644
--- a/doc/source/pika_driver.rst
+++ b/doc/source/admin/pika_driver.rst
diff --git a/doc/source/zmq_driver.rst b/doc/source/admin/zmq_driver.rst
index 88ccf8a..88ccf8a 100644
--- a/doc/source/zmq_driver.rst
+++ b/doc/source/admin/zmq_driver.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 8d6082d..9ac6887 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -50,7 +50,7 @@ pygments_style = 'sphinx'
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
-html_static_path = ['static']
+# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
diff --git a/doc/source/conffixture.rst b/doc/source/configration/conffixture.rst
index e66887d..e66887d 100644
--- a/doc/source/conffixture.rst
+++ b/doc/source/configration/conffixture.rst
diff --git a/doc/source/configration/index.rst b/doc/source/configration/index.rst
new file mode 100644
index 0000000..782a644
--- /dev/null
+++ b/doc/source/configration/index.rst
@@ -0,0 +1,9 @@
+============
+Configration
+============
+
+.. toctree::
+ :maxdepth: 2
+
+ opts
+ conffixture
diff --git a/doc/source/opts.rst b/doc/source/configration/opts.rst
index 9d94c18..9d94c18 100644
--- a/doc/source/opts.rst
+++ b/doc/source/configration/opts.rst
diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst
index 2ca75d1..ed5290b 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributor/contributing.rst
@@ -2,4 +2,4 @@
Contributing
==============
-.. include:: ../../CONTRIBUTING.rst
+.. include:: ../../../CONTRIBUTING.rst
diff --git a/doc/source/driver-dev-guide.rst b/doc/source/contributor/driver-dev-guide.rst
index 0062575..0062575 100644
--- a/doc/source/driver-dev-guide.rst
+++ b/doc/source/contributor/driver-dev-guide.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000..f4611c9
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,10 @@
+===========================
+Contributing oslo.messaging
+===========================
+
+.. toctree::
+ :maxdepth: 2
+
+ contributing
+ driver-dev-guide
+ supported-messaging-drivers
diff --git a/doc/source/supported-messaging-drivers.rst b/doc/source/contributor/supported-messaging-drivers.rst
index 5c25ed0..5c25ed0 100644
--- a/doc/source/supported-messaging-drivers.rst
+++ b/doc/source/contributor/supported-messaging-drivers.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f66d6e1..4c2452d 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,35 +1,19 @@
+==============
oslo.messaging
==============
The Oslo messaging API supports RPC and notifications over a number of
different messaging transports.
-Contents
-========
.. toctree::
:maxdepth: 1
- transport
- executors
- target
- server
- rpcclient
- notifier
- notification_driver
- notification_listener
- serializer
- exceptions
- opts
- conffixture
- drivers
- supported-messaging-drivers
- AMQP1.0
- pika_driver
- zmq_driver
- driver-dev-guide
- FAQ
- contributing
+ contributor/index
+ configration/index
+ admin/index
+ user/index
+ reference/index
Indices and tables
==================
diff --git a/doc/source/exceptions.rst b/doc/source/reference/exceptions.rst
index 2f01705..2f01705 100644
--- a/doc/source/exceptions.rst
+++ b/doc/source/reference/exceptions.rst
diff --git a/doc/source/executors.rst b/doc/source/reference/executors.rst
index e7d8a71..e7d8a71 100644
--- a/doc/source/executors.rst
+++ b/doc/source/reference/executors.rst
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
new file mode 100644
index 0000000..97fd328
--- /dev/null
+++ b/doc/source/reference/index.rst
@@ -0,0 +1,19 @@
+.. _using:
+
+=========
+Reference
+=========
+
+.. toctree::
+ :maxdepth: 2
+
+ transport
+ executors
+ target
+ server
+ rpcclient
+ notifier
+ notification_driver
+ notification_listener
+ serializer
+ exceptions
diff --git a/doc/source/notification_driver.rst b/doc/source/reference/notification_driver.rst
index d7368d8..d7368d8 100644
--- a/doc/source/notification_driver.rst
+++ b/doc/source/reference/notification_driver.rst
diff --git a/doc/source/notification_listener.rst b/doc/source/reference/notification_listener.rst
index 29a1dde..29a1dde 100644
--- a/doc/source/notification_listener.rst
+++ b/doc/source/reference/notification_listener.rst
diff --git a/doc/source/notifier.rst b/doc/source/reference/notifier.rst
index 4156b1e..4156b1e 100644
--- a/doc/source/notifier.rst
+++ b/doc/source/reference/notifier.rst
diff --git a/doc/source/rpcclient.rst b/doc/source/reference/rpcclient.rst
index 60da0cc..60da0cc 100644
--- a/doc/source/rpcclient.rst
+++ b/doc/source/reference/rpcclient.rst
diff --git a/doc/source/serializer.rst b/doc/source/reference/serializer.rst
index 64b5d45..64b5d45 100644
--- a/doc/source/serializer.rst
+++ b/doc/source/reference/serializer.rst
diff --git a/doc/source/server.rst b/doc/source/reference/server.rst
index 17a87d8..17a87d8 100644
--- a/doc/source/server.rst
+++ b/doc/source/reference/server.rst
diff --git a/doc/source/target.rst b/doc/source/reference/target.rst
index 57a627c..57a627c 100644
--- a/doc/source/target.rst
+++ b/doc/source/reference/target.rst
diff --git a/doc/source/transport.rst b/doc/source/reference/transport.rst
index 7dfca97..7dfca97 100644
--- a/doc/source/transport.rst
+++ b/doc/source/reference/transport.rst
diff --git a/doc/source/static/.placeholder b/doc/source/static/.placeholder
deleted file mode 100644
index e69de29..0000000
--- a/doc/source/static/.placeholder
+++ /dev/null
diff --git a/doc/source/FAQ.rst b/doc/source/user/FAQ.rst
index 2a67bba..2a67bba 100644
--- a/doc/source/FAQ.rst
+++ b/doc/source/user/FAQ.rst
diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst
new file mode 100644
index 0000000..f69be70
--- /dev/null
+++ b/doc/source/user/history.rst
@@ -0,0 +1 @@
+.. include:: ../../../ChangeLog
diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst
new file mode 100644
index 0000000..61bed54
--- /dev/null
+++ b/doc/source/user/index.rst
@@ -0,0 +1,13 @@
+====================
+Using oslo.messaging
+====================
+
+.. toctree::
+ :maxdepth: 2
+
+ FAQ
+
+.. toctree::
+ :maxdepth: 1
+
+ history