Browse Source

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
changes/35/476035/9
Masayuki Igawa 5 years ago
committed by Andreas Jaeger
parent
commit
31acf1316f
  1. 3
      doc/source/conf.py
  2. 1
      setup.cfg
  3. 0
      specs/other/.placeholder
  4. 0
      specs/other/implemented/.placeholder
  5. 12
      specs/other/implemented/placeholder.rst
  6. 12
      specs/other/placeholder.rst
  7. 0
      specs/patrole/implemented/.placeholder
  8. 1
      specs/patrole/implemented/rbac-policy-testing.rst
  9. 12
      specs/patrole/placeholder.rst
  10. 8
      specs/tempest/implemented/api-microversions-testing-support.rst
  11. 4
      specs/tempest/implemented/reintegrate-tempest-lib.rst
  12. 4
      specs/tempest/implemented/tempest-library.rst
  13. 2
      tox.ini

3
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']

1
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

0
specs/other/.placeholder

0
specs/other/implemented/.placeholder

12
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.

12
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.

0
specs/patrole/implemented/.placeholder

1
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]

12
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.

8
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 |

4
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

4
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

2
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 =

Loading…
Cancel
Save