From caa8058456e323e4c809a3b826226e6f48c04004 Mon Sep 17 00:00:00 2001 From: melissaml Date: Tue, 2 Jun 2020 18:12:46 +0800 Subject: [PATCH] Switch to newer openstackdocstheme versions Switch to openstackdocstheme 2.2.1 versions. Using these versions will allow especially: * 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: I3600b36580b01bd122d84dc14316b94f6c2ee78f --- doc/source/conf.py | 10 +++++----- lower-constraints.txt | 4 ++-- test-requirements.txt | 4 ++-- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 73c79b2..54e9611 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,10 +11,10 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = ['sphinx.ext.autodoc', 'openstackdocstheme'] # openstackdocstheme options -repository_name = 'openstack/mox3' -bug_project = '' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/mox3' +openstackdocs_bug_project = 'python-mox3' +openstackdocs_auto_name = False +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -41,7 +41,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- diff --git a/lower-constraints.txt b/lower-constraints.txt index 885df0b..44fdecc 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -11,7 +11,7 @@ Jinja2==2.10 linecache2==1.0.0 MarkupSafe==1.0 mccabe==0.4.0 -openstackdocstheme==1.18.1 +openstackdocstheme==2.2.1 pbr==2.0.0 pep8==1.7.1 pyflakes==1.0.0 @@ -22,7 +22,7 @@ pytz==2013.6 requests==2.14.2 six==1.10.0 snowballstemmer==1.2.1 -Sphinx==1.6.5 +Sphinx==2.2.0 sphinxcontrib-websupport==1.0.1 stestr==2.0.0 testtools==2.2.0 diff --git a/test-requirements.txt b/test-requirements.txt index 600a8d6..8a1f912 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,6 +11,6 @@ testtools>=2.2.0 # MIT six>=1.10.0 # MIT # this is required for the docs build jobs -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx>=2.2.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0