From f26534191ebf6c99439b5eff261bdbea7c403ce0 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 4 Jun 2020 09:35:01 +0200 Subject: [PATCH] Cleanup docs building a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Remove install_command from tox.ini, the default is fine - Update pbr requirements - Fix problems, mainly "Could not lex literal block" - Use py38 job for Victoria cycle Change-Id: Id706786bed4b20682704d524986850b7c71e225d --- .zuul.yaml | 4 ++-- requirements.txt | 2 +- setup.cfg | 11 ----------- specs/backlog/resource-capabilities.rst | 4 ++-- specs/mitaka/mistral-wf-signal-json-format.rst | 6 +++--- specs/newton/cinder-quota-resource.rst | 2 +- specs/ocata/neutron-quota-resource.rst | 2 +- specs/ocata/nova-quota-resource.rst | 2 +- tox.ini | 3 +-- 9 files changed, 12 insertions(+), 24 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index 99198961..59e88aac 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -3,7 +3,7 @@ - openstack-specs-jobs check: jobs: - - openstack-tox-py37 + - openstack-tox-py38 gate: jobs: - - openstack-tox-py37 + - openstack-tox-py38 diff --git a/requirements.txt b/requirements.txt index f5d9380f..a5318f4f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -pbr>=0.6,<1.0 +pbr!=2.1.0,>=2.0.0 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0 sphinx>=2.0.0,!=2.1.0 # BSD yasfb>=0.8.0 diff --git a/setup.cfg b/setup.cfg index 2ba1d670..94a953ad 100644 --- a/setup.cfg +++ b/setup.cfg @@ -11,14 +11,3 @@ classifier = Intended Audience :: Developers License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux - -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[pbr] -warnerrors = True - -[upload_sphinx] -upload-dir = doc/build/html diff --git a/specs/backlog/resource-capabilities.rst b/specs/backlog/resource-capabilities.rst index 787eba43..b3044e59 100644 --- a/specs/backlog/resource-capabilities.rst +++ b/specs/backlog/resource-capabilities.rst @@ -275,7 +275,7 @@ For example, given the :ref:`Puppet ` and Which would return: -.. code-block:: json +.. code-block:: { 'deployment': ['puppet', 'docker'] @@ -284,7 +284,7 @@ Which would return: A similar version of the call exists if the :ref:`capabilities-annotation-type` annotation is used: -.. code-block:: json +.. code-block:: { 'OS::TripleO::Controller': ['puppet/controller.yaml', diff --git a/specs/mitaka/mistral-wf-signal-json-format.rst b/specs/mitaka/mistral-wf-signal-json-format.rst index b3a3fd7b..3ae505f3 100644 --- a/specs/mitaka/mistral-wf-signal-json-format.rst +++ b/specs/mitaka/mistral-wf-signal-json-format.rst @@ -24,7 +24,7 @@ or even from ceilometer, the signaling request may have a predefined body, which is not compatible with the json format expected by the workflow resource. The os::mistral::workflow expects the body to be in this format: -.. code-block:: json +.. code-block:: { "input":{ @@ -37,7 +37,7 @@ The os::mistral::workflow expects the body to be in this format: however, ceilometer, for example, sends this body in the request: -.. code-block:: json +.. code-block:: { "severity": "low", @@ -134,4 +134,4 @@ Work Items Dependencies ============ -None \ No newline at end of file +None diff --git a/specs/newton/cinder-quota-resource.rst b/specs/newton/cinder-quota-resource.rst index c4f492f6..73df0361 100644 --- a/specs/newton/cinder-quota-resource.rst +++ b/specs/newton/cinder-quota-resource.rst @@ -119,7 +119,7 @@ template: We will add a default policy rule for this resource to be limited to administrators. -.. code-block:: json +.. code-block:: "resource_types:OS::Cinder::Quota": "rule:project_admin" diff --git a/specs/ocata/neutron-quota-resource.rst b/specs/ocata/neutron-quota-resource.rst index 85b92f39..d7eae43c 100644 --- a/specs/ocata/neutron-quota-resource.rst +++ b/specs/ocata/neutron-quota-resource.rst @@ -165,7 +165,7 @@ template: A default policy rule will be added for this resource to be limited to administrators. -.. code-block:: json +.. code-block:: "resource_types:OS::Neutron::Quota": "rule:project_admin" diff --git a/specs/ocata/nova-quota-resource.rst b/specs/ocata/nova-quota-resource.rst index 62632945..856037f0 100644 --- a/specs/ocata/nova-quota-resource.rst +++ b/specs/ocata/nova-quota-resource.rst @@ -179,7 +179,7 @@ updated. Otherwise, the project's quota will be updated. A default policy rule will be added for this resource to be limited to administrators. -.. code-block:: json +.. code-block:: "resource_types:OS::Nova::Quota": "rule:project_admin" diff --git a/tox.ini b/tox.ini index a9c4c4eb..97853947 100644 --- a/tox.ini +++ b/tox.ini @@ -6,7 +6,6 @@ skipsdist = True [testenv] basepython = python3 usedevelop = True -install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt @@ -20,7 +19,7 @@ commands = commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = sphinx-build -W -a -b html doc/source doc/build/html [testenv:spelling] deps =