From 8ced2b337df3892046c751d3dfa9d2cff48e86d9 Mon Sep 17 00:00:00 2001 From: Tom Barron Date: Fri, 17 Nov 2017 13:25:19 -0500 Subject: [PATCH] Remove unit test targets With the move to zuulv3, the openstack-tox-py* job definitions ignore doc only changes so we do not get spec linters run as part of the py27 and py35 targets any more. Run doc8 from the pep8 target. Also drop the spell check job since the way it is implemented causes the doc8 job to fail and the optional spellcheck job was not useful as a practial quick check anyways since it reported over 1000 "misspellings" because OpenStack vocabulary contains many words and acronyms not in its dictionary. Corresponding changes have been proposed for nova [1] and cinder [2]. [1] Ic87e79db6a8881398d670148b609e0b81658dfd1 [2] Ida20764edde3a07c89703d82b41958c96548b239 Change-Id: I82c8dbec713fc5575fd03c0ae290bf190bbdf8ca --- doc/source/conf.py | 12 ++---------- test-requirements.txt | 3 ++- tox.ini | 15 ++++++--------- 3 files changed, 10 insertions(+), 20 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index b8c2628..a347c6c 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,7 +32,7 @@ extensions = [ # TODO(tbarron): re-enable yasfb after # https://github.com/sphinxcontrib/yasfb/commit/62d18c66835320af4a71fb088cb502041478fb16 # is released; it currently breaks with python 3.5 - #'yasfb', + # 'yasfb', ] # Feed configuration for yasfb @@ -43,14 +43,6 @@ exclude_patterns = [ 'template.rst', ] -# Optionally allow the use of sphinxcontrib.spelling to verify the -# spelling of the documents. -try: - import sphinxcontrib.spelling - extensions.append('sphinxcontrib.spelling') -except ImportError: - pass - # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -97,4 +89,4 @@ latex_documents = [ ] # Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} +# intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/test-requirements.txt b/test-requirements.txt index bc1666d..fad4de4 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,2 +1,3 @@ -doc8 # Apache-2.0 +flake8 +doc8>=0.6.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index e81f1fc..12cb5ca 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 2.0 -envlist = docs,py35,py27 +envlist = docs,pep8 skipsdist = True [testenv] @@ -11,7 +11,11 @@ setenv = deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt whitelist_externals = echo -commands = echo 'None of tests exist. It is placeholder.' + +[testenv:pep8] +commands = + flake8 + doc8 --ignore D001 specs/ [testenv:venv] commands = {posargs} @@ -23,10 +27,3 @@ commands = python setup.py build_sphinx # Ignore D001 since we allow lines in excess of 79 characters. doc8 --ignore D001 --ignore-path .tox --ignore-path .eggs --ignore-path doc/build --ignore-path manila_specs.egg-info -e txt -e rst - -[testenv:spelling] -deps = - -r{toxinidir}/requirements.txt - sphinxcontrib-spelling - PyEnchant -commands = sphinx-build -b spelling doc/source doc/build/spelling