From ac82cef15a6e7a0a821257ee2a5981ef8d63bd41 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 10 Apr 2020 11:51:49 +0200 Subject: [PATCH] Cleanup py27 support Make a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Cleanup doc/source/conf.py to remove now obsolete content. - Use newer openstackdocstheme version - Remove install_command from tox.ini, the default is fine Change-Id: I8582f554fa966d9e9b9e260918db84dcc02041b7 --- doc/source/conf.py | 6 +----- requirements.txt | 2 +- setup.cfg | 11 ----------- tox.ini | 4 ++-- 4 files changed, 4 insertions(+), 19 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 5743bca..b59e5f8 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -13,16 +13,12 @@ # limitations under the License. import datetime -import os -import sys -sys.path.insert(0, os.path.abspath('../..')) # -- General configuration ---------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', 'openstackdocstheme', 'yasfb', @@ -52,7 +48,7 @@ project = u'telemetry-specs' copyright = u'%s, OpenStack Foundation' % datetime.date.today().year # openstackdocstheme options -repository_name = 'openstack/python-glanceclient' +repository_name = 'openstack/telemetry-specs' use_storyboard = True html_theme = 'openstackdocs' diff --git a/requirements.txt b/requirements.txt index d539515..c454588 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5 # BSD -openstackdocstheme>=1.22 +openstackdocstheme>=1.32.1 testrepository>=0.0.18 testtools>=0.9.34 yasfb>=0.5.1 diff --git a/setup.cfg b/setup.cfg index 4a39dbe..d4a7a0d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,14 +10,3 @@ classifier = Intended Audience :: Developers 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/tox.ini b/tox.ini index 2e3a814..ea21a59 100644 --- a/tox.ini +++ b/tox.ini @@ -8,7 +8,6 @@ ignore_basepython_conflict = True basepython = python3 usedevelop = True setenv = VIRTUAL_ENV={envdir} -install_command = pip install -U {opts} {packages} deps = -r{toxinidir}/requirements.txt # NOTE(tonyb): This project has chosen to *NOT* consume upper-constraints.txt commands = python setup.py testr --slowest --testr-args='{posargs}' @@ -17,4 +16,5 @@ commands = python setup.py testr --slowest --testr-args='{posargs}' commands = {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = + sphinx-build -W -b html doc/source doc/build/html