openstack/cinder
Code Issues Proposed changes

Fix various Sphinx warnings

Browse Source 
Change-Id: I68c9ff6fdf9115d1abb0fb756eb806b92af29286
This commit is contained in:
Dirk Mueller 2013-06-12 15:21:40 +02:00
parent f34aef3a29
commit 5e1502ad89
8 changed files with 50 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/devref/api.rst
View File

@ -26,7 +26,8 @@ Common Components
----------------- -----------------
The :mod:`cinder.api` Module The :mod:`cinder.api` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api .. automodule:: cinder.api
:noindex: :noindex:
:members: :members:
@ -34,7 +35,7 @@ The :mod:`cinder.api` Module
:show-inheritance: :show-inheritance:
The :mod:`cinder.api.cloud` Module The :mod:`cinder.api.cloud` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.cloud .. automodule:: cinder.api.cloud
:noindex: :noindex:
@ -46,7 +47,8 @@ OpenStack API
------------- -------------
The :mod:`openstack` Module The :mod:`openstack` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.openstack .. automodule:: cinder.api.openstack
:noindex: :noindex:
:members: :members:
@ -54,7 +56,8 @@ The :mod:`openstack` Module
:show-inheritance: :show-inheritance:
The :mod:`auth` Module The :mod:`auth` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.openstack.auth .. automodule:: cinder.api.openstack.auth
:noindex: :noindex:
:members: :members:
@ -65,7 +68,7 @@ EC2 API
------- -------
The :mod:`cinder.api.ec2` Module The :mod:`cinder.api.ec2` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.ec2 .. automodule:: cinder.api.ec2
:noindex: :noindex:

6
doc/source/devref/auth.rst
View File

@ -21,7 +21,7 @@ Authentication and Authorization
================================ ================================
The :mod:`cinder.quota` Module The :mod:`cinder.quota` Module
---------------------------- ------------------------------
.. automodule:: cinder.quota .. automodule:: cinder.quota
:noindex: :noindex:
@ -31,7 +31,7 @@ The :mod:`cinder.quota` Module
The :mod:`cinder.auth.signer` Module The :mod:`cinder.auth.signer` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.auth.signer .. automodule:: cinder.auth.signer
:noindex: :noindex:
@ -44,7 +44,7 @@ Auth Manager
------------ ------------
The :mod:`cinder.auth.manager` Module The :mod:`cinder.auth.manager` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.auth.manager .. automodule:: cinder.auth.manager
:noindex: :noindex:

22
doc/source/devref/cinder.rst
View File

@ -23,7 +23,7 @@ very well yet.
The :mod:`cinder.adminclient` Module The :mod:`cinder.adminclient` Module
---------------------------------- ------------------------------------
.. automodule:: cinder.adminclient .. automodule:: cinder.adminclient
:noindex: :noindex:
@ -33,7 +33,7 @@ The :mod:`cinder.adminclient` Module
The :mod:`cinder.context` Module The :mod:`cinder.context` Module
------------------------------ --------------------------------
.. automodule:: cinder.context .. automodule:: cinder.context
:noindex: :noindex:
@ -43,7 +43,7 @@ The :mod:`cinder.context` Module
The :mod:`cinder.exception` Module The :mod:`cinder.exception` Module
-------------------------------- ----------------------------------
.. automodule:: cinder.exception .. automodule:: cinder.exception
:noindex: :noindex:
@ -53,7 +53,7 @@ The :mod:`cinder.exception` Module
The :mod:`cinder.flags` Module The :mod:`cinder.flags` Module
---------------------------- ------------------------------
.. automodule:: cinder.flags .. automodule:: cinder.flags
:noindex: :noindex:
@ -63,7 +63,7 @@ The :mod:`cinder.flags` Module
The :mod:`cinder.process` Module The :mod:`cinder.process` Module
------------------------------ --------------------------------
.. automodule:: cinder.process .. automodule:: cinder.process
:noindex: :noindex:
@ -73,7 +73,7 @@ The :mod:`cinder.process` Module
The :mod:`cinder.rpc` Module The :mod:`cinder.rpc` Module
-------------------------- ----------------------------
.. automodule:: cinder.rpc .. automodule:: cinder.rpc
:noindex: :noindex:
@ -83,7 +83,7 @@ The :mod:`cinder.rpc` Module
The :mod:`cinder.server` Module The :mod:`cinder.server` Module
----------------------------- -------------------------------
.. automodule:: cinder.server .. automodule:: cinder.server
:noindex: :noindex:
@ -93,7 +93,7 @@ The :mod:`cinder.server` Module
The :mod:`cinder.test` Module The :mod:`cinder.test` Module
--------------------------- -----------------------------
.. automodule:: cinder.test .. automodule:: cinder.test
:noindex: :noindex:
@ -103,7 +103,7 @@ The :mod:`cinder.test` Module
The :mod:`cinder.utils` Module The :mod:`cinder.utils` Module
---------------------------- ------------------------------
.. automodule:: cinder.utils .. automodule:: cinder.utils
:noindex: :noindex:
@ -113,7 +113,7 @@ The :mod:`cinder.utils` Module
The :mod:`cinder.validate` Module The :mod:`cinder.validate` Module
------------------------------- ---------------------------------
.. automodule:: cinder.validate .. automodule:: cinder.validate
:noindex: :noindex:
@ -123,7 +123,7 @@ The :mod:`cinder.validate` Module
The :mod:`cinder.wsgi` Module The :mod:`cinder.wsgi` Module
--------------------------- -----------------------------
.. automodule:: cinder.wsgi .. automodule:: cinder.wsgi
:noindex: :noindex:

8
doc/source/devref/database.rst
View File

@ -19,7 +19,7 @@ The Database Layer
================== ==================
The :mod:`cinder.db.api` Module The :mod:`cinder.db.api` Module
----------------------------- -------------------------------
.. automodule:: cinder.db.api .. automodule:: cinder.db.api
:noindex: :noindex:
@ -32,13 +32,13 @@ The Sqlalchemy Driver
--------------------- ---------------------
The :mod:`cinder.db.sqlalchemy.api` Module The :mod:`cinder.db.sqlalchemy.api` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.db.sqlalchemy.api .. automodule:: cinder.db.sqlalchemy.api
:noindex: :noindex:
The :mod:`cinder.db.sqlalchemy.models` Module The :mod:`cinder.db.sqlalchemy.models` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.db.sqlalchemy.models .. automodule:: cinder.db.sqlalchemy.models
:noindex: :noindex:
@ -47,7 +47,7 @@ The :mod:`cinder.db.sqlalchemy.models` Module
:show-inheritance: :show-inheritance:
The :mod:`cinder.db.sqlalchemy.session` Module The :mod:`cinder.db.sqlalchemy.session` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.db.sqlalchemy.session .. automodule:: cinder.db.sqlalchemy.session
:noindex: :noindex:

12
doc/source/devref/fakes.rst
View File

@ -25,7 +25,7 @@ fake implementations of various drivers let you get on with your day.
The :mod:`cinder.virt.fake` Module The :mod:`cinder.virt.fake` Module
-------------------------------- ----------------------------------
.. automodule:: cinder.virt.fake .. automodule:: cinder.virt.fake
:noindex: :noindex:
@ -35,7 +35,7 @@ The :mod:`cinder.virt.fake` Module
The :mod:`cinder.auth.fakeldap` Module The :mod:`cinder.auth.fakeldap` Module
------------------------------------ --------------------------------------
.. automodule:: cinder.auth.fakeldap .. automodule:: cinder.auth.fakeldap
:noindex: :noindex:
@ -45,7 +45,7 @@ The :mod:`cinder.auth.fakeldap` Module
The :mod:`cinder.testing.fake.rabbit` Module The :mod:`cinder.testing.fake.rabbit` Module
------------------------------------------ --------------------------------------------
.. automodule:: cinder.testing.fake.rabbit .. automodule:: cinder.testing.fake.rabbit
:noindex: :noindex:
@ -55,7 +55,7 @@ The :mod:`cinder.testing.fake.rabbit` Module
The :class:`cinder.volume.driver.FakeAOEDriver` Class The :class:`cinder.volume.driver.FakeAOEDriver` Class
--------------------------------------------------- -----------------------------------------------------
.. autoclass:: cinder.volume.driver.FakeAOEDriver .. autoclass:: cinder.volume.driver.FakeAOEDriver
:noindex: :noindex:
@ -65,7 +65,7 @@ The :class:`cinder.volume.driver.FakeAOEDriver` Class
The :class:`cinder.tests.service_unittest.FakeManager` Class The :class:`cinder.tests.service_unittest.FakeManager` Class
---------------------------------------------------------- ------------------------------------------------------------
.. autoclass:: cinder.tests.service_unittest.FakeManager .. autoclass:: cinder.tests.service_unittest.FakeManager
:noindex: :noindex:
@ -75,7 +75,7 @@ The :class:`cinder.tests.service_unittest.FakeManager` Class
The :mod:`cinder.tests.api.openstack.fakes` Module The :mod:`cinder.tests.api.openstack.fakes` Module
------------------------------------------------ --------------------------------------------------
.. automodule:: cinder.tests.api.openstack.fakes .. automodule:: cinder.tests.api.openstack.fakes
:noindex: :noindex:

6
doc/source/devref/scheduler.rst
View File

@ -19,7 +19,7 @@ Scheduler
========= =========
The :mod:`cinder.scheduler.manager` Module The :mod:`cinder.scheduler.manager` Module
---------------------------------------- ------------------------------------------
.. automodule:: cinder.scheduler.manager .. automodule:: cinder.scheduler.manager
:noindex: :noindex:
@ -29,7 +29,7 @@ The :mod:`cinder.scheduler.manager` Module
The :mod:`cinder.scheduler.driver` Module The :mod:`cinder.scheduler.driver` Module
--------------------------------------- -----------------------------------------
.. automodule:: cinder.scheduler.driver .. automodule:: cinder.scheduler.driver
:noindex: :noindex:
@ -39,7 +39,7 @@ The :mod:`cinder.scheduler.driver` Module
The :mod:`cinder.scheduler.simple` Driver The :mod:`cinder.scheduler.simple` Driver
--------------------------------------- -----------------------------------------
.. automodule:: cinder.scheduler.simple .. automodule:: cinder.scheduler.simple
:noindex: :noindex:

4
doc/source/devref/volume.rst
View File

@ -22,7 +22,7 @@ Storage Volumes, Disks
The :mod:`cinder.volume.manager` Module The :mod:`cinder.volume.manager` Module
------------------------------------- ---------------------------------------
.. automodule:: cinder.volume.manager .. automodule:: cinder.volume.manager
:noindex: :noindex:
@ -31,7 +31,7 @@ The :mod:`cinder.volume.manager` Module
:show-inheritance: :show-inheritance:
The :mod:`cinder.volume.driver` Module The :mod:`cinder.volume.driver` Module
------------------------------------- --------------------------------------
.. automodule:: cinder.volume.driver .. automodule:: cinder.volume.driver
:noindex: :noindex:

26
doc/source/man/cinder-manage.rst
View File

@ -1,6 +1,6 @@
=========== =============
cinder-manage cinder-manage
=========== =============
------------------------------------------------------ ------------------------------------------------------
Control and manage OpenStack block storage 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. These sections describe the available categories and arguments for cinder-manage.
Cinder Db Cinder Db
~~~~~~~ ~~~~~~~~~
``cinder-manage db version`` ``cinder-manage db version``
@ -55,7 +55,7 @@ Cinder Db
Cinder Logs Cinder Logs
~~~~~~~~~ ~~~~~~~~~~~
``cinder-manage logs errors`` ``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). Displays cinder the most recent entries from syslog. The optional number argument specifies the number of entries to display (default 10).
Cinder Shell Cinder Shell
~~~~~~~~~~ ~~~~~~~~~~~~
``cinder-manage shell bpython`` ``cinder-manage shell bpython``
@ -89,7 +89,7 @@ Cinder Shell
Runs the named script from the specified path with flags set. Runs the named script from the specified path with flags set.
Cinder Volume Cinder Volume
~~~~~~~~~~ ~~~~~~~~~~~~~
``cinder-manage volume reattach <volume_id>`` ``cinder-manage volume reattach <volume_id>``
@ -100,35 +100,35 @@ Cinder Volume
Delete a volume without first checking that the volume is available. Delete a volume without first checking that the volume is available.
Cinder Host Cinder Host
~~~~~~~~~~ ~~~~~~~~~~~
``cinder-manage host list [<zone>]`` ``cinder-manage host list [<zone>]``
Displays a list of all physical hosts and their zone. The optional zone argument allows the list to be filtered on the requested zone. 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 Service
~~~~~~~~~~ ~~~~~~~~~~~~~~
``cinder-manage service list`` ``cinder-manage service list``
Displays a list of all cinder services and their host, zone, status, state and when the information was last updated. Displays a list of all cinder services and their host, zone, status, state and when the information was last updated.
Cinder Backup Cinder Backup
~~~~~~~~~~ ~~~~~~~~~~~~~
``cinder-manage backup list`` ``cinder-manage backup list``
Displays a list of all backups (including ones in progress) and the host on which the backup operation is running. Displays a list of all backups (including ones in progress) and the host on which the backup operation is running.
Cinder Version Cinder Version
~~~~~~~~~~ ~~~~~~~~~~~~~~
``cinder-manage version list`` ``cinder-manage version list``
Displays the codebase version cinder is running upon. Displays the codebase version cinder is running upon.
Cinder Storage Management Cinder Storage Management
~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
``cinder-manage sm flavor_create <label> <desc>`` ``cinder-manage sm flavor_create <label> <desc>``
@ -155,14 +155,14 @@ Cinder Storage Management
Removes the specified backend. Removes the specified backend.
Cinder Config Cinder Config
~~~~~~~~~~ ~~~~~~~~~~~~~
``cinder-manage config list`` ``cinder-manage config list``
Displays the current configuration parameters (options) for Cinder. Displays the current configuration parameters (options) for Cinder.
FILES FILES
======== =====
The cinder.conf file contains configuration information in the form of python-gflags. The cinder.conf file contains configuration information in the form of python-gflags.