Remove documentation of v2 API

With Sphinx 3.0.0 released yesterday, docs build started to fail:

Extension error:
Could not import extension wsmeext.sphinxext (exception: cannot import name 'l_' from 'sphinx.locale'

We only use wsme in the deprecated Blazar v2 API which we intend to
remove. Remove its documentation and the Sphinx extension from the
configuration first in order to fix the gate.

Change-Id: Ia740b98016c3384b37d55aff6e54ed640332fa01
This commit is contained in:
Pierre Riteau 2020-04-06 22:05:31 +02:00
parent 6e7333b76d
commit eb5cef0bf5
3 changed files with 0 additions and 61 deletions

View File

@ -35,7 +35,6 @@ extensions = ['sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'wsmeext.sphinxext',
'openstackdocstheme',
'oslo_config.sphinxext',
'oslo_config.sphinxconfiggen',

View File

@ -1,59 +0,0 @@
===============================
Blazar REST API v2 (deprecated)
===============================
**NOTE**: This version is deprecated. Please use the Blazar REST API v1.
1 General API information
-------------------------
This section contains base information about the Blazar REST API design,
including operations with different Blazar resource types and examples of
possible requests and responses. Blazar supports JSON data serialization
format, which means that requests with non empty body have to contain
"application/json" Content-Type header or it should be added ".json" extension
to the resource name in the request.
This should look like the following:
.. sourcecode:: http
GET /v2/leases.json
or
.. sourcecode:: http
GET /v2/leases
Accept: application/json
2 Leases
--------
**Description**
Lease is the main abstraction for the user in the Blazar case. Lease means
some kind of contract where start time, end time and resources to be reserved
are mentioned.
.. rest-controller:: blazar.api.v2.controllers.extensions.lease:LeasesController
:webprefix: /v2/leases
.. autotype:: blazar.api.v2.controllers.extensions.lease.Lease
:members:
3 Hosts
-------
**Description**
Host is the abstraction for a computehost in the Blazar case. Host means
a specific type of resource to be allocated.
.. rest-controller:: blazar.api.v2.controllers.extensions.host:HostsController
:webprefix: /v2/os-hosts
.. autotype:: blazar.api.v2.controllers.extensions.host.Host
:members:

View File

@ -6,4 +6,3 @@ Blazar REST API docs
:maxdepth: 1
Blazar REST API v1 <https://docs.openstack.org/api-ref/reservation/>
api-v2