From 9e095d09cab26bd29ae625d9263a43cf19799e77 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Tue, 19 May 2020 08:10:33 +0200 Subject: [PATCH] Switch to newer openstackdocstheme and reno versions Switch to openstackdocstheme 2.2.0 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. 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. Change-Id: I70badd9148fffe3f7a25980f3a45f0c656342442 --- doc/requirements.txt | 6 +++--- doc/source/conf.py | 7 ++++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 67bae283..a56782b5 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,6 +1,6 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.20.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD -reno>=2.5.0 # Apache-2.0 +openstackdocstheme>=2.2.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 3aec3a4a..d14f39a7 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,9 +26,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/python-zunclient' -bug_project = 'python-zunclient' -bug_tag = 'doc' +openstackdocs_repo_name = 'openstack/python-zunclient' +openstackdocs_pdf_link = True +openstackdocs_bug_project = 'python-zunclient' +openstackdocs_bug_tag = 'doc' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles.