From 31acf1316f1f081b2ba779e4f93b2fc80770a3ba Mon Sep 17 00:00:00 2001 From: Masayuki Igawa Date: Wed, 21 Jun 2017 16:49:35 +0900 Subject: [PATCH] Update sphinx library and treat warnings as errors This commit updates sphinx library and treats warnings as errors. We often miss doc warnings. So this commit makes them errors to build a better html document. Change-Id: I86fc23761ec24b0fdaae234cf37737dbc1bddd29 --- doc/source/conf.py | 3 +++ setup.cfg | 1 + specs/other/.placeholder | 0 specs/other/implemented/.placeholder | 0 specs/other/implemented/placeholder.rst | 12 ++++++++++++ specs/other/placeholder.rst | 12 ++++++++++++ specs/patrole/implemented/.placeholder | 0 specs/patrole/implemented/rbac-policy-testing.rst | 1 - specs/patrole/placeholder.rst | 12 ++++++++++++ .../api-microversions-testing-support.rst | 8 ++++---- .../tempest/implemented/reintegrate-tempest-lib.rst | 4 ++-- specs/tempest/implemented/tempest-library.rst | 4 ++-- tox.ini | 2 +- 13 files changed, 49 insertions(+), 10 deletions(-) delete mode 100644 specs/other/.placeholder delete mode 100644 specs/other/implemented/.placeholder create mode 100644 specs/other/implemented/placeholder.rst create mode 100644 specs/other/placeholder.rst delete mode 100644 specs/patrole/implemented/.placeholder create mode 100644 specs/patrole/placeholder.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index 17b418d..62541e6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -303,3 +303,6 @@ epub_copyright = u'2014, OpenStack QA Team' # Allow duplicate toc entries. #epub_tocdup = True + +# Do not warn about non-local image URI +suppress_warnings = ['image.nonlocal_uri'] diff --git a/setup.cfg b/setup.cfg index 791fc22..9184724 100644 --- a/setup.cfg +++ b/setup.cfg @@ -15,6 +15,7 @@ classifier = all_files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [pbr] warnerrors = True diff --git a/specs/other/.placeholder b/specs/other/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/specs/other/implemented/.placeholder b/specs/other/implemented/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/specs/other/implemented/placeholder.rst b/specs/other/implemented/placeholder.rst new file mode 100644 index 0000000..0228aab --- /dev/null +++ b/specs/other/implemented/placeholder.rst @@ -0,0 +1,12 @@ +.. + This work is licensed under a Creative Commons Attribution 3.0 Unported + License. + + http://creativecommons.org/licenses/by/3.0/legalcode + +=========== +Placeholder +=========== + +This is just a placeholder file to avoid sphinx errors. Please remove this +file when you add a new rst file. diff --git a/specs/other/placeholder.rst b/specs/other/placeholder.rst new file mode 100644 index 0000000..0228aab --- /dev/null +++ b/specs/other/placeholder.rst @@ -0,0 +1,12 @@ +.. + This work is licensed under a Creative Commons Attribution 3.0 Unported + License. + + http://creativecommons.org/licenses/by/3.0/legalcode + +=========== +Placeholder +=========== + +This is just a placeholder file to avoid sphinx errors. Please remove this +file when you add a new rst file. diff --git a/specs/patrole/implemented/.placeholder b/specs/patrole/implemented/.placeholder deleted file mode 100644 index e69de29..0000000 diff --git a/specs/patrole/implemented/rbac-policy-testing.rst b/specs/patrole/implemented/rbac-policy-testing.rst index 877377c..709d9eb 100644 --- a/specs/patrole/implemented/rbac-policy-testing.rst +++ b/specs/patrole/implemented/rbac-policy-testing.rst @@ -91,7 +91,6 @@ List the qa projects that this spec effects. For example: Implementation ============== Assignee(s) - ----------- Primary assignees: david-purcell [david.purcell@att.com] diff --git a/specs/patrole/placeholder.rst b/specs/patrole/placeholder.rst new file mode 100644 index 0000000..0228aab --- /dev/null +++ b/specs/patrole/placeholder.rst @@ -0,0 +1,12 @@ +.. + This work is licensed under a Creative Commons Attribution 3.0 Unported + License. + + http://creativecommons.org/licenses/by/3.0/legalcode + +=========== +Placeholder +=========== + +This is just a placeholder file to avoid sphinx errors. Please remove this +file when you add a new rst file. diff --git a/specs/tempest/implemented/api-microversions-testing-support.rst b/specs/tempest/implemented/api-microversions-testing-support.rst index c5ab5f4..7cfdf13 100644 --- a/specs/tempest/implemented/api-microversions-testing-support.rst +++ b/specs/tempest/implemented/api-microversions-testing-support.rst @@ -11,9 +11,9 @@ Tempest support for API microversions testing https://blueprints.launchpad.net/tempest/+spec/api-microversions-testing-support -Since Kilo, nova has implemented API microversions and the other components (Ironic, etc) -also implemented it now. However, currently Tempest does not have any support for microversions -and doesn't test it at all. +Since Kilo, nova has implemented API microversions and the other components +(Ironic, etc) also implemented it now. However, currently Tempest does not +have any support for microversions and doesn't test it at all. This proposal is to add microversions testing support in Tempest. Problem description @@ -81,7 +81,7 @@ Test classes for each microversion TestClass D: min_microversion = '2.5', max_microversion = '2.10' +--------------------+-----------------------------------------------------+ - | Configuration | Test classes | + | Configuration | Test classes | | (min, max) | (Passed microversion) | +====================+=====================================================+ | None, None | A(Not passed), B(Not passed), C & D - Skipped | diff --git a/specs/tempest/implemented/reintegrate-tempest-lib.rst b/specs/tempest/implemented/reintegrate-tempest-lib.rst index 112283c..be2c956 100644 --- a/specs/tempest/implemented/reintegrate-tempest-lib.rst +++ b/specs/tempest/implemented/reintegrate-tempest-lib.rst @@ -134,8 +134,8 @@ Target Milestone for completion: Work Items ---------- - * Take ownership of tempest on pypi [1] - * Enable publishing tempest to pypi [2] + * Take ownership of tempest on pypi [1]_ + * Enable publishing tempest to pypi [2]_ * Add reno release notes to both tempest and tempest-lib * Iterate through reintegration: * Move all the code from tempest-lib to tempest.lib in the tempest repo diff --git a/specs/tempest/implemented/tempest-library.rst b/specs/tempest/implemented/tempest-library.rst index 207c998..5bdf025 100644 --- a/specs/tempest/implemented/tempest-library.rst +++ b/specs/tempest/implemented/tempest-library.rst @@ -54,7 +54,7 @@ this workflow with python-novaclient CLI tests: #. Add CLI base test classes with core functionality to the new library #. Switch the tempest CLI tests to use the library instead #. Remove code in tempest which has been switched to the library - #. Add a functional test suite to the novaclient repository and copy the + #. Add a functional test suite to the novaclient repository and copy the appropriate CLI tests from tempest #. Remove the copied novaclient CLI tests from tempest @@ -154,4 +154,4 @@ library conversion. References ========== -.. [1] http://lists.openstack.org/pipermail/openstack-dev/2014-March/028920.html +- http://lists.openstack.org/pipermail/openstack-dev/2014-March/028920.html diff --git a/tox.ini b/tox.ini index d04892b..e707a1c 100644 --- a/tox.ini +++ b/tox.ini @@ -15,7 +15,7 @@ commands = {posargs} [testenv:docs] basepython = python3 -commands = python setup.py build_sphinx +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:spelling] deps =