From 25d06aa08aeff67e681b75bce158a0aa8ebc94ed Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sat, 30 May 2020 15:57:37 +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: I5cdda37a7312c05b62e7468200486c6a7f6e1397 --- doc/requirements.txt | 4 ++-- doc/source/conf.py | 10 ++++++---- releasenotes/source/conf.py | 9 +++++---- test-requirements.txt | 6 +++--- 4 files changed, 16 insertions(+), 13 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 910d4d3..50d1565 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,5 +2,5 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.32.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 29baf79..4ea0510 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,9 +41,11 @@ project = u'watcher-tempest-plugin' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/watcher-tempest-plugin' -bug_project = 'Tempest plugin watcher-tempest-plugin' -bug_tag = '' +openstackdocs_repo_name = 'openstack/watcher-tempest-plugin' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'Tempest plugin watcher-tempest-plugin' +openstackdocs_bug_tag = '' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -53,7 +55,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 bd20c7a..41639dc 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,9 +56,10 @@ project = u'watcher-tempest-plugin Release Notes' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/watcher-tempest-plugin' -bug_project = 'Tempest plugin watcher-tempest-plugin' -bug_tag = '' +openstackdocs_repo_name = 'openstack/watcher-tempest-plugin' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'Tempest plugin watcher-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 = [] diff --git a/test-requirements.txt b/test-requirements.txt index 49a2713..037acf9 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -7,13 +7,13 @@ hacking<0.13,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +sphinx>=2.0.0,!=2.1.0 # BSD oslotest>=3.2.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=2.2.0 # MIT -openstackdocstheme>=1.32.1 # 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 # bandit bandit>=1.1.0 # Apache-2.0