From 9c03ff1b96a0f13b22284d16941893a50c2cdcd4 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Thu, 4 Jun 2020 13:53:27 +0200 Subject: [PATCH] Switch to newer openstackdocstheme version Switch to openstackdocstheme 2.2.1 version. Using this version will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_version to not auto-version the documents. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Cleanup setup: Remove unneeded requirements, cleanup tox.ini and setup.*. Change-Id: I0cd384d4df8107e3cb45f512d79f9f81c1d10f9f --- doc/source/conf.py | 15 ++++++--------- requirements.txt | 7 ++----- setup.cfg | 9 --------- setup.py | 9 --------- test-requirements.txt | 10 +++------- tox.ini | 5 +---- 6 files changed, 12 insertions(+), 43 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index a506f7c..d3756d9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,7 +11,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import subprocess import sys import os @@ -36,7 +35,7 @@ todo_include_todos = True # Define shorthand roles for making links to common destinations. extlinks = { - 'repo': ('https://git.opendev.org/cgit/%s', ''), + 'repo': ('https://opendev.org/%s', ''), } # Add any paths that contain templates here, relative to this directory. @@ -85,11 +84,15 @@ add_module_names = False show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = [] +# openstackdocstheme options +openstackdocs_auto_version = False +openstackdocs_auto_name = False + # -- Options for HTML output --------------------------------------------------- @@ -129,12 +132,6 @@ html_title = 'StarlingX Governance' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. #html_use_smartypants = True diff --git a/requirements.txt b/requirements.txt index 75dca40..8f76f31 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,9 +1,6 @@ # 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. -six>=1.9.0 # MIT -requests>=2.14.2 # Apache-2.0 -ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD -PrettyTable<0.8,>=0.7.1 # BSD + docutils>=0.11 # OSI-Approved Open Source, Public Domain -Jinja2>=2.10 # BSD License (3 clause) + diff --git a/setup.cfg b/setup.cfg index dd44462..35eb4c8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -15,12 +15,3 @@ classifier = Programming Language :: Python :: 3 Programming Language :: Python :: 3.5 Programming Language :: Python :: 3.6 - -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source -builders = html - -[pbr] -warnerrors = True diff --git a/setup.py b/setup.py index 566d844..cd35c3c 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>=2.0.0'], pbr=True) diff --git a/test-requirements.txt b/test-requirements.txt index ca20b40..1aa2cf8 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,10 +2,6 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. # needed for doc build -sphinx>=1.6.2 # BSD -openstackdocstheme>=1.25.1 # Apache-2.0 -hacking<0.12,>=0.11.0 # Apache-2.0 -oslotest>=1.10.0 # Apache-2.0 -stestr>=2.0.0 # Apache-2.0 -testresources>=2.0.0 # Apache-2.0/BSD -fixtures>=3.0.0 # Apache-2.0/BSD +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 + diff --git a/tox.ini b/tox.ini index 7f97b58..fc451b5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,12 +1,11 @@ [tox] -envlist = docs,py35,py27 +envlist = docs minversion = 2.0 skipsdist = True [testenv] basepython = python3 usedevelop = True -install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt @@ -21,5 +20,3 @@ commands = {posargs} [testenv:docs] commands = sphinx-build -v -W -b html -d doc/build/doctrees doc/source doc/build/html -[flake8] -exclude=.tox,doc/source/conf.py