From 8e84ccdcbdf630665e6a5e76cd48fedf1e475640 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 15:23:49 +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. 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: I6d6ed7c7db614dd1b5a678d496d6d8790383d8e9 --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 9 ++++----- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 827758f..9bfa056 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ # 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. -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index b26f38e..296a5f6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -38,10 +38,12 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # openstackdocstheme options -repository_name = 'openstack/renderspec' +openstackdocs_repo_name = 'openstack/renderspec' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'renderspec' # -- Options for HTML output -------------------------------------------------- @@ -54,9 +56,6 @@ repository_name = 'openstack/renderspec' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project -git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" -html_last_updated_fmt = os.popen(git_cmd).read() - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]).