Cleanup py27 support, fix docs

This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Remove install_command from tox.ini, the default is fine
- Enable sphinx warnings, fix all

Change-Id: I921faba15db8657115f78b7f008145c177a6ec59

doc/requirements.txt

@@ -1,3 +1,3 @@
 pbr!=2.1.0,>=2.0.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
+openstackdocstheme>=2.0.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD

doc/source/conf.py

@@ -13,16 +13,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import os
-import sys
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../../'))
-sys.path.insert(0, os.path.abspath('../'))
-sys.path.insert(0, os.path.abspath('./'))
-
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -30,10 +20,9 @@ sys.path.insert(0, os.path.abspath('./'))
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
+extensions = [
               'sphinx.ext.doctest',
               'sphinx.ext.todo',
-              'sphinx.ext.coverage',
               'sphinx.ext.viewcode',
               'openstackdocstheme',
               ]
@@ -43,8 +32,6 @@ repository_name = 'openstack/blazar-specs'
 bug_project = 'blazar'
 bug_tag = ''
 
-wsme_protocols = ['restjson', 'restxml']
-
 # The suffix of source filenames.
 source_suffix = '.rst'
 

doc/source/index.rst

@@ -10,7 +10,7 @@ Specifications
 Specifications for the blazar project are available here.
 
 Ussuri
------
+------
 
 This section has a list of specs for Ussuri release.
 

doc/source/specs/queens/flavors-extra-specs.rst

@@ -98,7 +98,7 @@ REST API impact
 
 Request Example:
 
-  .. sourcecode:: json
+  .. sourcecode::
 
      {
        "name": "instance-reservation-1",
@@ -124,7 +124,7 @@ Request Example:
 
 Response Example:
 
-  .. sourcecode:: json
+  .. sourcecode::
 
      {
        "leases": {

doc/source/specs/rocky/multi-freepools.rst

@@ -96,7 +96,7 @@ REST API impact
 
 Request Example:
 
-  .. sourcecode:: json
+  .. sourcecode::
 
      {
        "name": "instance-reservation-1",
@@ -126,7 +126,7 @@ Request Example:
 
 Response Example:
 
-  .. sourcecode:: json
+  .. sourcecode::
 
      {
        "leases": {

doc/source/specs/rocky/resource-availability.rst

@@ -85,7 +85,7 @@ REST API impact
 
 Response Example:
 
-  .. sourcecode:: json
+  .. sourcecode::
 
      {
        "allocations": [
@@ -116,7 +116,7 @@ Response Example:
 
 Response Example:
 
-  .. sourcecode:: json
+  .. sourcecode::
 
      {
        "allocation": {

doc/source/specs/stein/floatingip-reservation.rst

@@ -197,7 +197,7 @@ Changes in the lease APIs
 
 Request Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "name": "floatingip-reservation-1",
@@ -219,7 +219,7 @@ Request Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "lease": {
@@ -278,7 +278,7 @@ The four new APIs are admin APIs by default.
 
 Request Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "floating_network_id": "external-network-id",
@@ -293,7 +293,7 @@ Request Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "floatingip": {
@@ -311,7 +311,7 @@ Response Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "floatingips": [
@@ -332,7 +332,7 @@ Response Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "floatingip": {

doc/source/specs/ussuri/network-reservation.rst

@@ -174,7 +174,7 @@ Changes in the lease APIs
 
 Request Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "name": "network-reservation-1",
@@ -194,7 +194,7 @@ Request Example:
 
 Response Example
 
-.. sourcecode:: json
+.. sourcecode::
 
     {
       "lease": {
@@ -240,7 +240,7 @@ The five new APIs are admin APIs by default.
 
 Request Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
    {
      "network_type": "vlan",
@@ -255,7 +255,7 @@ Request Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
   {
     "network": {
@@ -273,7 +273,7 @@ Response Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
   {
     "networks": [
@@ -293,7 +293,7 @@ Response Example:
 
 Response Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
   {
     "network": {
@@ -315,7 +315,7 @@ No Request body or Response body.
 
   Request Example:
 
-.. sourcecode:: json
+.. sourcecode::
 
   {
     "extra_capability_sample": "bar"
@@ -336,7 +336,6 @@ No Request body or Response body.
     }
   }
 
-.. sourcecode:: json
 
 Security impact
 ---------------

setup.cfg

@@ -10,14 +10,3 @@ classifier =
     Environment :: OpenStack
     License :: OSI Approved :: Apache Software License
     Operating System :: POSIX :: Linux
-
-[build_sphinx]
-source-dir = doc/source
-build-dir = doc/build
-all_files = 1
-
-[upload_sphinx]
-upload-dir = doc/build/html
-
-[pbr]
-warnerrors = True

tox.ini

@@ -13,8 +13,7 @@ deps = -r{toxinidir}/doc/requirements.txt
 commands = {posargs}
 
 [testenv:docs]
-# NOTE(priteau): no -W as there are still warnings to fix in specs source.
-commands = sphinx-build -b html doc/source doc/build/html
+commands = sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:pdf-docs]
 basepython = python3