From 9468fcf2dc10aa113161dd1fc0ac8cf1db6e640f Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 30 May 2020 15:52:41 +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. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. 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: I524d5c8b09b31dbc6781792d5dc91994f7ed4791 --- doc/source/conf.py | 9 +++++---- releasenotes/source/conf.py | 9 +++++---- test-requirements.txt | 4 ++-- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index acefcd5..d20942e 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,9 +41,10 @@ project = u'blazar-tempest-plugin' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/blazar-tempest-plugin' -bug_project = 'blazar' -bug_tag = '' +openstackdocs_repo_name = 'openstack/blazar-tempest-plugin' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'blazar' +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 dd6cba0..00f6578 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,9 +56,10 @@ project = u'blazar-tempest-plugin Release Notes' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/blazar-tempest-plugin' -bug_project = 'blazar' -bug_tag = '' +openstackdocs_repo_name = 'openstack/blazar-tempest-plugin' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'blazar' +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 = [] diff --git a/test-requirements.txt b/test-requirements.txt index c89984d..95d8f3d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,6 +6,6 @@ hacking>=1.1.0,<1.2.0 # Apache-2.0 # docs 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