From 063cc75c87caf6e35c860b5ac485eb618186b9e5 Mon Sep 17 00:00:00 2001 From: Ivan Kolodyazhny Date: Tue, 14 Jul 2015 18:24:29 +0300 Subject: [PATCH] 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 --- doc/source/devref/api.rst | 51 +-------------------------------------- doc/source/index.rst | 2 -- 2 files changed, 1 insertion(+), 52 deletions(-) diff --git a/doc/source/devref/api.rst b/doc/source/devref/api.rst index 1848ae215..46211733d 100644 --- a/doc/source/devref/api.rst +++ b/doc/source/devref/api.rst @@ -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 ----- diff --git a/doc/source/index.rst b/doc/source/index.rst index 77ddd28be..ef6dba472 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 -- 2.45.2