From e5f2ba7c7d08d369f831409c3e07357d28d5feb9 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 19 May 2020 07:58:25 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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. Change-Id: I42b7a7d44fc50218f99f6106324945864b46d74f --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 5 ++--- releasenotes/source/conf.py | 5 ++--- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index aaa896c8..e6783eef 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,4 +1,4 @@ -openstackdocstheme>=1.20.0 # Apache-2.0 -reno>=1.8.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD +openstackdocstheme>=2.2.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD sphinx-argparse>=0.2.2 # MIT diff --git a/doc/source/conf.py b/doc/source/conf.py index 1a596f91..55e4bc84 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,9 +27,8 @@ extensions = [ html_theme = 'openstackdocs' # openstackdocstheme options -repository_name = 'openstack/python-tempestconf' -bug_project = '912' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/python-tempestconf' +openstackdocs_use_storyboard = True # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 6f10ef27..3582cbb5 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -43,9 +43,8 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/python-tempestconf' -bug_project = '912' -bug_tag = 'releasenotes' +openstackdocs_repo_name = 'openstack/python-tempestconf' +openstackdocs_use_storyboard = True # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']