Fix docs for REST API history and Scheduler

In manila/api/openstack/rest_api_version_history.rst,
underscores were used instead of hyphens to underline version '2.14'.
Fix to remove visual incongruity.

In doc/source/devref/scheduler.rst, not all drivers were added or
updated. Fix to include all drivers.

Partially-implements bp improve-manila-developer-docs

Change-Id: I513a4b51ab5f3d8c0cdb5aa013c93ecd07a85a20
This commit is contained in:
Sumit Kumar 2016-05-05 14:39:47 -04:00
parent 5c961ab615
commit 724d8dfa0a
2 changed files with 215 additions and 9 deletions
doc/source/devref
manila/api/openstack

@ -18,6 +18,7 @@
Scheduler
=========
The :mod:`manila.scheduler.manager` Module
------------------------------------------
@ -28,9 +29,59 @@ The :mod:`manila.scheduler.manager` Module
:show-inheritance:
The :mod:`manila.scheduler.drivers.base` Module
The :mod:`manila.scheduler.base_handler` Module
-----------------------------------------------
.. automodule:: manila.scheduler.base_handler
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.host_manager` Module
-----------------------------------------------
.. automodule:: manila.scheduler.host_manager
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.rcpapi` Module
-----------------------------------------
.. automodule:: manila.scheduler.rcpapi
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.scheduler_options` Module
----------------------------------------------------
.. automodule:: manila.scheduler.scheduler_options
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.drivers.filter` Module
-------------------------------------------------
.. automodule:: manila.scheduler.drivers.filter
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.drivers.base` Module
-----------------------------------------------
.. automodule:: manila.scheduler.drivers.base
:noindex:
:members:
@ -38,8 +89,18 @@ The :mod:`manila.scheduler.drivers.base` Module
:show-inheritance:
The :mod:`manila.scheduler.drivers.simple` Driver
-----------------------------------------
The :mod:`manila.scheduler.drivers.chance` Module
-------------------------------------------------
.. automodule:: manila.scheduler.drivers.chance
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.drivers.simple` Module
-------------------------------------------------
.. automodule:: manila.scheduler.drivers.simple
:noindex:
@ -48,13 +109,158 @@ The :mod:`manila.scheduler.drivers.simple` Driver
:show-inheritance:
Tests
-----
Scheduler Filters
=================
The :mod:`scheduler` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: manila.tests.scheduler
The :mod:`manila.scheduler.filters.availability_zone` Filter
------------------------------------------------------------
.. automodule:: manila.scheduler.filters.availability_zone
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.base` Filter
-----------------------------------------------
.. automodule:: manila.scheduler.filters.base
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.base_host` Filter
----------------------------------------------------
.. automodule:: manila.scheduler.filters.base_host
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.capabilities` Filter
-------------------------------------------------------
.. automodule:: manila.scheduler.filters.capabilities
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.capacity` Filter
---------------------------------------------------
.. automodule:: manila.scheduler.filters.capacity
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.consistency_group` Filter
------------------------------------------------------------
.. automodule:: manila.scheduler.filters.consistency_group
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.extra_specs_ops` Filter
----------------------------------------------------------
.. automodule:: manila.scheduler.filters.extra_specs_ops
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.ignore_attempted_hosts` Filter
-----------------------------------------------------------------
.. automodule:: manila.scheduler.filters.ignore_attempted_hosts
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.json` Filter
-----------------------------------------------
.. automodule:: manila.scheduler.filters.json
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.retry` Filter
------------------------------------------------
.. automodule:: manila.scheduler.filters.retry
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.filters.share_replication` Filter
------------------------------------------------------------
.. automodule:: manila.scheduler.filters.share_replication
:noindex:
:members:
:undoc-members:
:show-inheritance:
Scheduler Weighers
==================
The :mod:`manila.scheduler.weighers.base` Weigher
-------------------------------------------------
.. automodule:: manila.scheduler.weighers.base
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.weighers.base_host` Weigher
------------------------------------------------------
.. automodule:: manila.scheduler.weighers.base_host
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.weighers.capacity` Weigher
-----------------------------------------------------
.. automodule:: manila.scheduler.weighers.capacity
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.scheduler.weighers.pool` Weigher
-------------------------------------------------
.. automodule:: manila.scheduler.weighers.pool
:noindex:
:members:
:undoc-members:

@ -95,7 +95,7 @@ user documentation.
Add 'cephx' authentication type for the CephFS Native driver.
2.14
____
----
Added attribute 'preferred' to export locations. Drivers may use this
field to identify which export locations are most efficient and should be
used preferentially by clients. Also, change 'uuid' field to 'id', move