From 0b78b7be34cb5b0cb288874eb9cab99493fb7923 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 1 Jun 2020 16:13:19 +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. 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: Ifc60ddf5a5696f250a01761bc1a3d7f73df8ed63 --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 9 +++++---- releasenotes/source/conf.py | 9 +++++---- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 805ecb6..6c010bf 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,7 +4,7 @@ sphinxcontrib-apidoc>=0.2.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD -openstackdocstheme>=2.0.0 # Apache-2.0 +openstackdocstheme>=2.2.1 # Apache-2.0 # releasenotes -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 3a4eea0..2620933 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,9 +41,10 @@ project = u'openstack' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/openstack' -bug_project = 'trove_tempest_plugin' -bug_tag = '' +openstackdocs_repo_name = 'openstack/openstack' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'trove_tempest_plugin' +openstackdocs_bug_tag = '' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -53,7 +54,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/releasenotes/source/conf.py b/releasenotes/source/conf.py index 63d31dc..270c1cc 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,9 +56,10 @@ project = u'trove_tempest_plugin Release Notes' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/openstack' -bug_project = 'trove_tempest_plugin' -bug_tag = '' +openstackdocs_repo_name = 'openstack/openstack' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'trove_tempest_plugin' +openstackdocs_bug_tag = '' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -100,7 +101,7 @@ exclude_patterns = [] # 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 = []