From 24422999eeb65f58904f79184e90631062073575 Mon Sep 17 00:00:00 2001 From: Paul Belanger Date: Sat, 30 Mar 2019 20:34:29 -0400 Subject: [PATCH] Rework tox -edocs This allows us to drop setup.cfg / setup.py files. Change-Id: I80243d7d619f8d724fab7c44dc6c1164f3aa5fb3 Signed-off-by: Paul Belanger --- doc/requirements.txt | 7 +++++++ setup.cfg | 23 ----------------------- setup.py | 28 ---------------------------- test-requirements.txt | 1 - tox.ini | 8 +++++++- 5 files changed, 14 insertions(+), 53 deletions(-) create mode 100644 doc/requirements.txt delete mode 100644 setup.cfg delete mode 100644 setup.py diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..1f3277f --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +# this is required for the docs build jobs +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +doc8>=0.6.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 66b2417..0000000 --- a/setup.cfg +++ /dev/null @@ -1,23 +0,0 @@ -[metadata] -name = ansible-role-zuul -summary = Ansible role to manage Zuul -description-file = - README.rst -author = OpenStack -author-email = openstack-discuss@lists.openstack.org -home-page = http://www.openstack.org/ -classifier = - Intended Audience :: System Administrators - License :: OSI Approved :: Apache Software License - Operating System :: POSIX :: Linux - -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[pbr] -warnerrors = True - -[wheel] -universal = 1 diff --git a/setup.py b/setup.py deleted file mode 100644 index bb3db27..0000000 --- a/setup.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -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/test-requirements.txt b/test-requirements.txt index 9ea7158..4c4414f 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,3 +1,2 @@ ansible-lint hacking<0.11,>=0.10 -sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 diff --git a/tox.ini b/tox.ini index 3243c9f..66f820a 100644 --- a/tox.ini +++ b/tox.ini @@ -9,7 +9,13 @@ deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +whitelist_externals = + bash +commands= + bash -c "rm -rf doc/build" + doc8 doc + sphinx-build -b html doc/source doc/build/html [testenv:venv] commands = {posargs}