diff --git a/doc/source/AMQP1.0.rst b/doc/source/admin/AMQP1.0.rst similarity index 100% rename from doc/source/AMQP1.0.rst rename to doc/source/admin/AMQP1.0.rst diff --git a/doc/source/drivers.rst b/doc/source/admin/drivers.rst similarity index 100% rename from doc/source/drivers.rst rename to doc/source/admin/drivers.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 000000000..d032aaf25 --- /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 similarity index 100% rename from doc/source/pika_driver.rst rename to doc/source/admin/pika_driver.rst diff --git a/doc/source/zmq_driver.rst b/doc/source/admin/zmq_driver.rst similarity index 100% rename from doc/source/zmq_driver.rst rename to doc/source/admin/zmq_driver.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 8d6082d28..9ac6887c2 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 similarity index 100% rename from doc/source/conffixture.rst rename to doc/source/configration/conffixture.rst diff --git a/doc/source/configration/index.rst b/doc/source/configration/index.rst new file mode 100644 index 000000000..782a64422 --- /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 similarity index 100% rename from doc/source/opts.rst rename to doc/source/configration/opts.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 53% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst index 2ca75d1bf..ed5290bbd 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 similarity index 100% rename from doc/source/driver-dev-guide.rst rename to 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 000000000..f4611c9fa --- /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 similarity index 100% rename from doc/source/supported-messaging-drivers.rst rename to doc/source/contributor/supported-messaging-drivers.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index f66d6e1d8..4c2452daa 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 similarity index 100% rename from doc/source/exceptions.rst rename to doc/source/reference/exceptions.rst diff --git a/doc/source/executors.rst b/doc/source/reference/executors.rst similarity index 100% rename from doc/source/executors.rst rename to doc/source/reference/executors.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 000000000..97fd328b6 --- /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 similarity index 100% rename from doc/source/notification_driver.rst rename to doc/source/reference/notification_driver.rst diff --git a/doc/source/notification_listener.rst b/doc/source/reference/notification_listener.rst similarity index 100% rename from doc/source/notification_listener.rst rename to doc/source/reference/notification_listener.rst diff --git a/doc/source/notifier.rst b/doc/source/reference/notifier.rst similarity index 100% rename from doc/source/notifier.rst rename to doc/source/reference/notifier.rst diff --git a/doc/source/rpcclient.rst b/doc/source/reference/rpcclient.rst similarity index 100% rename from doc/source/rpcclient.rst rename to doc/source/reference/rpcclient.rst diff --git a/doc/source/serializer.rst b/doc/source/reference/serializer.rst similarity index 100% rename from doc/source/serializer.rst rename to doc/source/reference/serializer.rst diff --git a/doc/source/server.rst b/doc/source/reference/server.rst similarity index 100% rename from doc/source/server.rst rename to doc/source/reference/server.rst diff --git a/doc/source/target.rst b/doc/source/reference/target.rst similarity index 100% rename from doc/source/target.rst rename to doc/source/reference/target.rst diff --git a/doc/source/transport.rst b/doc/source/reference/transport.rst similarity index 100% rename from doc/source/transport.rst rename to doc/source/reference/transport.rst diff --git a/doc/source/static/.placeholder b/doc/source/static/.placeholder deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/source/FAQ.rst b/doc/source/user/FAQ.rst similarity index 100% rename from doc/source/FAQ.rst rename to doc/source/user/FAQ.rst diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 000000000..f69be70b3 --- /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 000000000..61bed549b --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,13 @@ +==================== +Using oslo.messaging +==================== + +.. toctree:: + :maxdepth: 2 + + FAQ + +.. toctree:: + :maxdepth: 1 + + history