From 7aa078296c44b83c6920d59b97e3831fdbb11f69 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Fri, 13 Dec 2019 22:47:51 +0000 Subject: [PATCH] Fix doc job, pep8 error and remove py27 This commit does multiple fix 1. Doc building still use deprcated oslosphinx and incompatible version of yasfb which lead to error- sphinx.errors.ExtensionError: Could not import extension yasfb (exception: cannot import name 'logging') Replace oslosphinx with openstackdocstheme to fix the error. 2. Switch py27 job with py37 3. fix the pep8 error Change-Id: I33ad4d0a2924082b7c56ac7c7973ad02ac6e9df5 --- .zuul.yaml | 4 ++-- doc/source/conf.py | 4 ++-- requirements.txt | 6 +++--- tests/test_title.py | 4 ++-- tox.ini | 7 ++----- 5 files changed, 11 insertions(+), 14 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index f3848fb..9919896 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -3,7 +3,7 @@ - openstack-specs-jobs check: jobs: - - openstack-tox-py27 + - openstack-tox-py37 gate: jobs: - - openstack-tox-py27 + - openstack-tox-py37 diff --git a/doc/source/conf.py b/doc/source/conf.py index aefe838..9ff09d6 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', - 'oslosphinx', + 'openstackdocstheme', 'yasfb', ] @@ -75,7 +75,7 @@ pygments_style = 'sphinx' # html_theme_path = ["."] # html_theme = '_theme' # html_static_path = ['static'] -html_theme_options = {} +html_theme = "openstackdocs" # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/requirements.txt b/requirements.txt index c8aeae6..99d52a2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ pbr>=0.6,<1.0 -oslosphinx>=2.2.0.0a2 -sphinx>=1.1.2,<1.2 -yasfb>=0.5.1 +openstackdocstheme +sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +yasfb>=0.8.0 testrepository>=0.0.18 testtools>=0.9.34 stestr>=2.0.0 diff --git a/tests/test_title.py b/tests/test_title.py index 2031c82..8dbab25 100644 --- a/tests/test_title.py +++ b/tests/test_title.py @@ -41,7 +41,7 @@ class TestTitles(testtools.TestCase): def _check_titles(self, spec, titles): self.assertTrue(len(titles) >= 4, - "Titles count in '%s' doesn't match expected" % spec) + "Titles count in '%s' doesn't match expected" % spec) problem = 'Problem description' driver = 'Driver description' self.assertTrue(problem in titles or driver in titles) @@ -84,7 +84,7 @@ class TestTitles(testtools.TestCase): def test_template(self): # NOTE (e0ne): adding 'template.rst' to ignore dirs to exclude it from # os.listdir output - ignored_dirs = {'template.rst', 'api',} + ignored_dirs = {'template.rst', 'api'} files = ['specs/template.rst'] diff --git a/tox.ini b/tox.ini index e951d81..f0f255a 100644 --- a/tox.ini +++ b/tox.ini @@ -1,9 +1,10 @@ [tox] minversion = 1.6 -envlist = docs,py27,pep8 +envlist = docs,pep8 skipsdist = True [testenv] +basepython = python3 usedevelop = True install_command = pip install -U {opts} {packages} setenv = @@ -13,11 +14,9 @@ deps = -r{toxinidir}/requirements.txt commands = stestr run --slowest {posargs} [testenv:venv] -basepython = python3 commands = {posargs} [testenv:docs] -basepython = python3 commands = python setup.py build_sphinx [testenv:spelling] @@ -28,7 +27,6 @@ deps = commands = sphinx-build -b spelling doc/source doc/build/spelling [testenv:cover] -basepython = python3 setenv = PYTHON=coverage run --source specs --parallel-mode commands = @@ -38,7 +36,6 @@ commands = coverage xml -o cover/coverage.xml [testenv:pep8] -basepython = python3 commands = flake8 [flake8]