From 7752b4c912ff891541820606526a9de57d9882f3 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 31 May 2020 19:48:33 +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: I5ebcd8f2cfa9f44830279679e3d6bcd24212bd93 --- doc/source/conf.py | 11 +++++------ releasenotes/source/conf.py | 8 ++++---- test-requirements.txt | 4 ++-- 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index f95bf21..9193066 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -36,13 +36,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'openstack' -copyright = u'2017, OpenStack Developers' +project = 'monasca-tempest-plugin' +copyright = '2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/openstack' -bug_project = 'monasca_tempest_plugin' -bug_tag = '' +openstackdocs_repo_name = 'openstack/monasca-tempest-plugin' +openstackdocs_use_storyboard = True # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -52,7 +51,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 5017714..11f2e86 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -55,9 +55,9 @@ master_doc = 'index' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/openstack' -bug_project = 'monasca_tempest_plugin' -bug_tag = '' +openstackdocs_repo_name = 'openstack/openstack' +openstackdocs_bug_project = 'monasca_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 @@ -99,7 +99,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 fde010c..ae03f19 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,6 +5,6 @@ hacking>=3.0.1,<3.1.0;python_version>='3.5' # Apache-2.0 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