openstack
/
oslo.tools
Code Issues Proposed changes

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.

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.

Depends-On: https://review.opendev.org/728938
Change-Id: I53dfc4b7d9fff5f6d8fce02728bc91dada252ec7
This commit is contained in:
Andreas Jaeger 2020-05-16 10:00:42 +02:00
parent 3f09ba20c2
commit 612d9b3194
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/requirements.txt
View File

@ -2,8 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# this is required for the docs build jobs
sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD

6
doc/source/conf.py
View File

@ -26,9 +26,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/oslo.tools'
bug_project = 'oslo.tools'
bug_tag = ''
openstackdocs_repo_name = 'openstack/oslo.tools'
openstackdocs_bug_project = 'oslo.tools'
openstackdocs_bug_tag = ''
# The suffix of source filenames.
source_suffix = '.rst'