From bc2f958d6c7371ccafdd6a2f612d034fcebb3c17 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 3 Jun 2020 17:17:56 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.1 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. 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: Id712703a2472b16e3c07ce2f9e4675cf81aaf22e --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 6 +++--- releasenotes/source/conf.py | 10 +++++----- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 6e3f8f9..c4ef00e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,6 +4,6 @@ # this is required for the docs build jobs sphinx>=2.0.0,!=2.1.0 # BSD -openstackdocstheme>=2.0.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index fe89b0b..245f634 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -65,9 +65,9 @@ target_name = 'ansible-role' + role_name title = 'OpenStack-Ansible Documentation: ' + role_name + 'role' # openstackdocstheme options -repository_name = 'openstack/' + target_name -bug_project = project.lower() -bug_tag = '' +openstackdocs_repo_name = 'openstack/' + target_name +openstackdocs_bug_project = project.lower() +openstackdocs_bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index f79c801..599463d 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -58,8 +58,8 @@ category = 'Miscellaneous' copyright = '2014-2016, OpenStack-Ansible Contributors' description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.' project = 'OpenStack-Ansible' -role_name = 'rabbitmq_server' -target_name = 'openstack-ansible-' + role_name +role_name = 'qdrouterd' +target_name = 'ansible-role-' + role_name title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role' # Release notes do not need a version number in the title, they @@ -70,9 +70,9 @@ release = '' version = '' # openstackdocstheme options -repository_name = 'openstack/' + target_name -bug_project = project.lower() -bug_tag = '' +openstackdocs_repo_name = 'openstack/' + target_name +openstackdocs_bug_project = project.lower() +openstackdocs_bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.