From 1d3fa5934d3fa0e6918a17d1bd45efb961406c65 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 11 Apr 2020 15:28:55 +0200 Subject: [PATCH] Cleanup py27 support and docs This repo is now testing only with Python 3, so let's make a few cleanups: - Remove python 2.7 stanza from setup.py - Remove obsolete sections from setup.cfg - Update requirements, no need for python_version anymore - Cleanup */source/conf.py to remove now obsolete content. - Use newer openstackdocstheme version - Remove install_command from tox.ini, the default is fine - Enable warnings for doc builds, fix doc build problems Change-Id: Id1ecc85694dddd177dde628a031b7cb637932fbc --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 3 --- doc/source/index.rst | 3 +++ releasenotes/source/conf.py | 3 --- setup.cfg | 12 ------------ setup.py | 9 --------- tox.ini | 8 ++++---- 7 files changed, 9 insertions(+), 33 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index f8369f8b..ddfe9c56 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,8 +2,8 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx>=1.8.0,!=2.1.0 # BSD +openstackdocstheme>=1.31.2 # Apache-2.0 # releasenotes reno>=2.5.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index a12bfbcc..c96d9ab4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -42,9 +42,6 @@ copyright = u'2018, OpenStack Developers' # openstackdocstheme options repository_name = 'openstack/openstack-helm-images' -bug_project = '64' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' use_storyboard = True # If true, '()' will be appended to :func: etc. cross-reference text. diff --git a/doc/source/index.rst b/doc/source/index.rst index acf87199..002d5716 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -63,11 +63,14 @@ an overview of the build process for each container. :maxdepth: 2 :caption: Contents: + calicoctl-utility ceph-config-helper + ceph-daemon gate-utils libvirt mariadb openvswitch + ospurge tempest vbmc loci diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3d182ff4..3aeac3f7 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -57,9 +57,6 @@ copyright = u'2018, OpenStack Developers' # openstackdocstheme options repository_name = 'openstack/openstack-helm-images' -bug_project = '64' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' use_storyboard = True # The version info for the project you're documenting, acts as replacement for diff --git a/setup.cfg b/setup.cfg index 5a28075c..4ce27783 100644 --- a/setup.cfg +++ b/setup.cfg @@ -13,15 +13,3 @@ classifier = Intended Audience :: Developers License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -warning-is-error = True - -[pbr] -warnerrors = True - -[wheel] -universal = 1 diff --git a/setup.py b/setup.py index 056c16c2..f76858d5 100644 --- a/setup.py +++ b/setup.py @@ -13,17 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. -# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT import setuptools -# In python < 2.7.4, a lazy loading of package `pbr` will break -# setuptools if some other modules registered functions in `atexit`. -# solution from: http://bugs.python.org/issue15881#msg170215 -try: - import multiprocessing # noqa -except ImportError: - pass - setuptools.setup( setup_requires=['pbr'], pbr=True) diff --git a/tox.ini b/tox.ini index 8a1e9bb1..79071dd7 100644 --- a/tox.ini +++ b/tox.ini @@ -6,8 +6,6 @@ ignore_basepython_conflict = True [testenv] basepython = python3 -install_command = - pip install -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} {opts} {packages} setenv = PYTHONUNBUFFERED=1 VIRTUAL_ENV={envdir} @@ -23,11 +21,13 @@ whitelist_externals = commands = {posargs} [testenv:docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt commands = bash -c "rm -rf doc/build" doc8 doc - sphinx-build --keep-going -b html doc/source doc/build/html + sphinx-build -W --keep-going -b html doc/source doc/build/html [doc8] extensions = .rst