openstack
/
oslo-specs
Code Issues Proposed changes

Switch to newer openstackdocstheme version 

Switch to openstackdocstheme 2.2.0. Using this versions
will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Remove reno, it's not used in this repo.

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.

Set openstackdocs_auto_version to not auto-version the documents.

Depends-On: https://review.opendev.org/728938
Change-Id: If1e4ca76901ec5528969f4d7c706fc840f02562b
This commit is contained in:
Andreas Jaeger 2020-05-16 09:52:43 +02:00
parent ec8c81fb07
commit f9fb7ed826
2 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/requirements.txt
View File

@ -2,7 +2,6 @@
# 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.1.0 # BSD
openstackdocstheme>=1.18.1 # 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
yasfb>=0.8.0 # BSD

6
doc/source/conf.py
View File

@ -37,7 +37,11 @@ extensions = [
'yasfb',
]
repository_name = 'openstack/oslo-specs'
openstackdocs_repo_name = 'openstack/oslo-specs'
openstackdocs_auto_version = False
version = ''
release = ''
# Feed configuration for yasfb
feed_base_url = 'https://specs.openstack.org/openstack/oslo-specs'