Remove obsolete API from documentation

Cinder doesn't support EC2 API and doesn't contain cinder.api.ec2
module.
Also references to cinder.api.openstack.auth and cinder.api.cloud were
removed too.

Change-Id: I30f71cf541d93d3ab68780328e2dea6ebd326b63
This commit is contained in:
Ivan Kolodyazhny 2015-07-14 18:24:29 +03:00
parent c4c7acc2ae
commit 063cc75c87
2 changed files with 1 additions and 52 deletions

View File

@ -19,8 +19,7 @@ API Endpoint
============
Cinder has a system for managing multiple APIs on different subdomains.
Currently there is support for the OpenStack API, as well as the Amazon EC2
API.
Currently there is support for the OpenStack API.
Common Components
-----------------
@ -34,15 +33,6 @@ The :mod:`cinder.api` Module
:undoc-members:
:show-inheritance:
The :mod:`cinder.api.cloud` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.cloud
:noindex:
:members:
:undoc-members:
:show-inheritance:
OpenStack API
-------------
@ -55,45 +45,6 @@ The :mod:`openstack` Module
:undoc-members:
:show-inheritance:
The :mod:`auth` Module
~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.openstack.auth
:noindex:
:members:
:undoc-members:
:show-inheritance:
EC2 API
-------
The :mod:`cinder.api.ec2` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.ec2
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`cloud` Module
~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.ec2.cloud
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`metadatarequesthandler` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: cinder.api.ec2.metadatarequesthandler
:noindex:
:members:
:undoc-members:
:show-inheritance:
Tests
-----

View File

@ -25,7 +25,6 @@ Cinder is an OpenStack project to provide "block storage as a service".
* **Fault-Tolerant**: Isolated processes avoid cascading failures
* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
* **Open Standards**: Be a reference implementation for a community-driven api
* **API Compatibility**: Cinder strives to provide API-compatible with popular systems like Amazon EC2
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional draft and project documentation on Cinder and other components of OpenStack can
@ -59,4 +58,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
r Docs