From 5e1502ad89db8ad4cf121d4ca73d4d137aec72a7 Mon Sep 17 00:00:00 2001 From: Dirk Mueller Date: Wed, 12 Jun 2013 15:21:40 +0200 Subject: [PATCH] Fix various Sphinx warnings Change-Id: I68c9ff6fdf9115d1abb0fb756eb806b92af29286 --- doc/source/devref/api.rst | 13 ++++++++----- doc/source/devref/auth.rst | 6 +++--- doc/source/devref/cinder.rst | 22 +++++++++++----------- doc/source/devref/database.rst | 8 ++++---- doc/source/devref/fakes.rst | 12 ++++++------ doc/source/devref/scheduler.rst | 6 +++--- doc/source/devref/volume.rst | 4 ++-- doc/source/man/cinder-manage.rst | 26 +++++++++++++------------- 8 files changed, 50 insertions(+), 47 deletions(-) diff --git a/doc/source/devref/api.rst b/doc/source/devref/api.rst index 1d8e770c150..1848ae2157e 100644 --- a/doc/source/devref/api.rst +++ b/doc/source/devref/api.rst @@ -26,7 +26,8 @@ Common Components ----------------- The :mod:`cinder.api` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. automodule:: cinder.api :noindex: :members: @@ -34,7 +35,7 @@ The :mod:`cinder.api` Module :show-inheritance: The :mod:`cinder.api.cloud` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.api.cloud :noindex: @@ -46,7 +47,8 @@ OpenStack API ------------- The :mod:`openstack` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. automodule:: cinder.api.openstack :noindex: :members: @@ -54,7 +56,8 @@ The :mod:`openstack` Module :show-inheritance: The :mod:`auth` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~ + .. automodule:: cinder.api.openstack.auth :noindex: :members: @@ -65,7 +68,7 @@ EC2 API ------- The :mod:`cinder.api.ec2` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.api.ec2 :noindex: diff --git a/doc/source/devref/auth.rst b/doc/source/devref/auth.rst index ee84e3ae5c2..1bd32235a3c 100644 --- a/doc/source/devref/auth.rst +++ b/doc/source/devref/auth.rst @@ -21,7 +21,7 @@ Authentication and Authorization ================================ The :mod:`cinder.quota` Module ----------------------------- +------------------------------ .. automodule:: cinder.quota :noindex: @@ -31,7 +31,7 @@ The :mod:`cinder.quota` Module The :mod:`cinder.auth.signer` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.auth.signer :noindex: @@ -44,7 +44,7 @@ Auth Manager ------------ The :mod:`cinder.auth.manager` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.auth.manager :noindex: diff --git a/doc/source/devref/cinder.rst b/doc/source/devref/cinder.rst index 57aba56be5d..b629a83ea22 100644 --- a/doc/source/devref/cinder.rst +++ b/doc/source/devref/cinder.rst @@ -23,7 +23,7 @@ very well yet. The :mod:`cinder.adminclient` Module ----------------------------------- +------------------------------------ .. automodule:: cinder.adminclient :noindex: @@ -33,7 +33,7 @@ The :mod:`cinder.adminclient` Module The :mod:`cinder.context` Module ------------------------------- +-------------------------------- .. automodule:: cinder.context :noindex: @@ -43,7 +43,7 @@ The :mod:`cinder.context` Module The :mod:`cinder.exception` Module --------------------------------- +---------------------------------- .. automodule:: cinder.exception :noindex: @@ -53,7 +53,7 @@ The :mod:`cinder.exception` Module The :mod:`cinder.flags` Module ----------------------------- +------------------------------ .. automodule:: cinder.flags :noindex: @@ -63,7 +63,7 @@ The :mod:`cinder.flags` Module The :mod:`cinder.process` Module ------------------------------- +-------------------------------- .. automodule:: cinder.process :noindex: @@ -73,7 +73,7 @@ The :mod:`cinder.process` Module The :mod:`cinder.rpc` Module --------------------------- +---------------------------- .. automodule:: cinder.rpc :noindex: @@ -83,7 +83,7 @@ The :mod:`cinder.rpc` Module The :mod:`cinder.server` Module ------------------------------ +------------------------------- .. automodule:: cinder.server :noindex: @@ -93,7 +93,7 @@ The :mod:`cinder.server` Module The :mod:`cinder.test` Module ---------------------------- +----------------------------- .. automodule:: cinder.test :noindex: @@ -103,7 +103,7 @@ The :mod:`cinder.test` Module The :mod:`cinder.utils` Module ----------------------------- +------------------------------ .. automodule:: cinder.utils :noindex: @@ -113,7 +113,7 @@ The :mod:`cinder.utils` Module The :mod:`cinder.validate` Module -------------------------------- +--------------------------------- .. automodule:: cinder.validate :noindex: @@ -123,7 +123,7 @@ The :mod:`cinder.validate` Module The :mod:`cinder.wsgi` Module ---------------------------- +----------------------------- .. automodule:: cinder.wsgi :noindex: diff --git a/doc/source/devref/database.rst b/doc/source/devref/database.rst index 9d6b9daa94d..2897c8b49d2 100644 --- a/doc/source/devref/database.rst +++ b/doc/source/devref/database.rst @@ -19,7 +19,7 @@ The Database Layer ================== The :mod:`cinder.db.api` Module ------------------------------ +------------------------------- .. automodule:: cinder.db.api :noindex: @@ -32,13 +32,13 @@ The Sqlalchemy Driver --------------------- The :mod:`cinder.db.sqlalchemy.api` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.db.sqlalchemy.api :noindex: The :mod:`cinder.db.sqlalchemy.models` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.db.sqlalchemy.models :noindex: @@ -47,7 +47,7 @@ The :mod:`cinder.db.sqlalchemy.models` Module :show-inheritance: The :mod:`cinder.db.sqlalchemy.session` Module -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. automodule:: cinder.db.sqlalchemy.session :noindex: diff --git a/doc/source/devref/fakes.rst b/doc/source/devref/fakes.rst index ecc3ce277f0..25a769be5ff 100644 --- a/doc/source/devref/fakes.rst +++ b/doc/source/devref/fakes.rst @@ -25,7 +25,7 @@ fake implementations of various drivers let you get on with your day. The :mod:`cinder.virt.fake` Module --------------------------------- +---------------------------------- .. automodule:: cinder.virt.fake :noindex: @@ -35,7 +35,7 @@ The :mod:`cinder.virt.fake` Module The :mod:`cinder.auth.fakeldap` Module ------------------------------------- +-------------------------------------- .. automodule:: cinder.auth.fakeldap :noindex: @@ -45,7 +45,7 @@ The :mod:`cinder.auth.fakeldap` Module The :mod:`cinder.testing.fake.rabbit` Module ------------------------------------------- +-------------------------------------------- .. automodule:: cinder.testing.fake.rabbit :noindex: @@ -55,7 +55,7 @@ The :mod:`cinder.testing.fake.rabbit` Module The :class:`cinder.volume.driver.FakeAOEDriver` Class ---------------------------------------------------- +----------------------------------------------------- .. autoclass:: cinder.volume.driver.FakeAOEDriver :noindex: @@ -65,7 +65,7 @@ The :class:`cinder.volume.driver.FakeAOEDriver` Class The :class:`cinder.tests.service_unittest.FakeManager` Class ----------------------------------------------------------- +------------------------------------------------------------ .. autoclass:: cinder.tests.service_unittest.FakeManager :noindex: @@ -75,7 +75,7 @@ The :class:`cinder.tests.service_unittest.FakeManager` Class The :mod:`cinder.tests.api.openstack.fakes` Module ------------------------------------------------- +-------------------------------------------------- .. automodule:: cinder.tests.api.openstack.fakes :noindex: diff --git a/doc/source/devref/scheduler.rst b/doc/source/devref/scheduler.rst index 304a4572c9e..6e531fb1ae9 100644 --- a/doc/source/devref/scheduler.rst +++ b/doc/source/devref/scheduler.rst @@ -19,7 +19,7 @@ Scheduler ========= The :mod:`cinder.scheduler.manager` Module ----------------------------------------- +------------------------------------------ .. automodule:: cinder.scheduler.manager :noindex: @@ -29,7 +29,7 @@ The :mod:`cinder.scheduler.manager` Module The :mod:`cinder.scheduler.driver` Module ---------------------------------------- +----------------------------------------- .. automodule:: cinder.scheduler.driver :noindex: @@ -39,7 +39,7 @@ The :mod:`cinder.scheduler.driver` Module The :mod:`cinder.scheduler.simple` Driver ---------------------------------------- +----------------------------------------- .. automodule:: cinder.scheduler.simple :noindex: diff --git a/doc/source/devref/volume.rst b/doc/source/devref/volume.rst index 89a53146f3b..d9f73c31585 100644 --- a/doc/source/devref/volume.rst +++ b/doc/source/devref/volume.rst @@ -22,7 +22,7 @@ Storage Volumes, Disks The :mod:`cinder.volume.manager` Module -------------------------------------- +--------------------------------------- .. automodule:: cinder.volume.manager :noindex: @@ -31,7 +31,7 @@ The :mod:`cinder.volume.manager` Module :show-inheritance: The :mod:`cinder.volume.driver` Module -------------------------------------- +-------------------------------------- .. automodule:: cinder.volume.driver :noindex: diff --git a/doc/source/man/cinder-manage.rst b/doc/source/man/cinder-manage.rst index 4d3f486cf08..2776c975602 100644 --- a/doc/source/man/cinder-manage.rst +++ b/doc/source/man/cinder-manage.rst @@ -1,6 +1,6 @@ -=========== +============= cinder-manage -=========== +============= ------------------------------------------------------ Control and manage OpenStack block storage @@ -43,7 +43,7 @@ You can also run with a category argument such as 'db' to see a list of all comm These sections describe the available categories and arguments for cinder-manage. Cinder Db -~~~~~~~ +~~~~~~~~~ ``cinder-manage db version`` @@ -55,7 +55,7 @@ Cinder Db Cinder Logs -~~~~~~~~~ +~~~~~~~~~~~ ``cinder-manage logs errors`` @@ -66,7 +66,7 @@ Cinder Logs Displays cinder the most recent entries from syslog. The optional number argument specifies the number of entries to display (default 10). Cinder Shell -~~~~~~~~~~ +~~~~~~~~~~~~ ``cinder-manage shell bpython`` @@ -89,7 +89,7 @@ Cinder Shell Runs the named script from the specified path with flags set. Cinder Volume -~~~~~~~~~~ +~~~~~~~~~~~~~ ``cinder-manage volume reattach `` @@ -100,35 +100,35 @@ Cinder Volume Delete a volume without first checking that the volume is available. Cinder Host -~~~~~~~~~~ +~~~~~~~~~~~ ``cinder-manage host list []`` Displays a list of all physical hosts and their zone. The optional zone argument allows the list to be filtered on the requested zone. Cinder Service -~~~~~~~~~~ +~~~~~~~~~~~~~~ ``cinder-manage service list`` Displays a list of all cinder services and their host, zone, status, state and when the information was last updated. Cinder Backup -~~~~~~~~~~ +~~~~~~~~~~~~~ ``cinder-manage backup list`` Displays a list of all backups (including ones in progress) and the host on which the backup operation is running. Cinder Version -~~~~~~~~~~ +~~~~~~~~~~~~~~ ``cinder-manage version list`` Displays the codebase version cinder is running upon. Cinder Storage Management -~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~ ``cinder-manage sm flavor_create