From c99dfcf7a7da49aafd2120b866b2e360cc625daf Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 10 Jun 2020 16:08:26 +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 Change-Id: I7f07fc60f45deb2a415af1216ab5b37398cb2929 --- doc/source/conf.py | 13 +++++++++---- requirements.txt | 4 ++-- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 4ee416e..b32cfa9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -35,9 +35,14 @@ source_suffix = '.rst' master_doc = 'index' # openstackdocstheme options -repository_name = 'openstack/service-types-authority' -bug_project = '' -bug_tag = '' +openstackdocs_repo_name = 'openstack/service-types-authority' +openstackdocs_auto_name = False +openstackdocs_auto_version = False +openstackdocs_bug_project = '' +openstackdocs_bug_tag = '' + +version = '' +release = '' # General information about the project. project = u'Service Types Authority' @@ -74,7 +79,7 @@ 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 = [] diff --git a/requirements.txt b/requirements.txt index 207e8a4..bdc8e7b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 jsonschema requests PyYAML>=3.10.0 # MIT -openstackdocstheme>=1.31.2 # Apache-2.0 -sphinx>=1.6.1 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD