openstack/python-zunclient
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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
This commit is contained in:
Andreas Jaeger 2020-05-19 08:10:33 +02:00
parent 64eb1ff376
commit 9e095d09ca
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -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

7
doc/source/conf.py
View File

@ -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.