diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2017-08-22 11:41:50 +0100 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2017-08-22 11:41:50 +0100 |
| commit | 5d0b4bdc6e62c680dffb8aae8a1d95b869f89220 (patch) | |
| tree | 52b892252644982eeb59289667cc9d1ef9dda447 /doc/source/contributor | |
| parent | b7d34684607bbc0d8c507970661d0b1d3bed7843 (diff) | |
| download | python-cinderclient-5d0b4bdc6e62c680dffb8aae8a1d95b869f89220.tar.gz | |
Use Sphinx 1.5 warning-is-error
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.
Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
Diffstat (limited to 'doc/source/contributor')
| -rw-r--r-- | doc/source/contributor/unit_tests.rst | 16 |
1 files changed, 5 insertions, 11 deletions
diff --git a/doc/source/contributor/unit_tests.rst b/doc/source/contributor/unit_tests.rst index 988740d..c1b7dce 100644 --- a/doc/source/contributor/unit_tests.rst +++ b/doc/source/contributor/unit_tests.rst @@ -9,7 +9,7 @@ Cinderclient contains a suite of unit tests, in the cinderclient/tests/unit directory. Any proposed code change will be automatically rejected by the OpenStack -Jenkins server [#f1]_ if the change causes unit test failures. +Jenkins server if the change causes unit test failures. Running the tests ----------------- @@ -54,7 +54,7 @@ Note that there has been talk around deprecating this wrapper and this method of testing, it's currently available still but it may be good to get used to using tox or even ostestr directly. -Documenation is left in place for those that still use it. +Documentation is left in place for those that still use it. Flags ----- @@ -115,10 +115,9 @@ flag:: Virtualenv ---------- -By default, the tests use the Python packages installed inside a -virtualenv [#f2]_. (This is equivalent to using the ``-V, --virtualenv`` flag). -If the virtualenv does not exist, it will be created the first time the tests -are run. +By default, the tests use the Python packages installed inside a virtualenv. +(This is equivalent to using the ``-V, --virtualenv`` flag). If the virtualenv +does not exist, it will be created the first time the tests are run. If you wish to recreate the virtualenv, call ``run_tests.sh`` with the flag:: @@ -157,8 +156,3 @@ Note that you may use any location (not just ``/tmp``!) as long as it is not a shared folder. .. rubric:: Footnotes - -.. [#f1] See :doc:`jenkins`. - -.. [#f2] See :doc:`development.environment` for more details about the use of - virtualenv. |