diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-15 20:25:02 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-18 21:07:24 +0200 |
| commit | db6a84accf7462700bc6b9069a8b34deed9be895 (patch) | |
| tree | 8403d0b3053e1a31c30611183a7309519f38b98a | |
| parent | f62ddb15244d5b5aa0c54f2d6b0ae30799835eb2 (diff) | |
| download | oslo-db-db6a84accf7462700bc6b9069a8b34deed9be895.tar.gz | |
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. A
couple of variables are also not needed anymore, remove them.
Depends-On: https://review.opendev.org/728938
Change-Id: I072cf215486d672eacd3a57483cb2b311483c844
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rwxr-xr-x | doc/source/conf.py | 7 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 6 |
3 files changed, 9 insertions, 10 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index e0781e8..39130db 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,8 +1,8 @@ # 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.8.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD doc8>=0.6.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index afa698b..2cc5a9a 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,15 +23,14 @@ extensions = [ 'stevedore.sphinxext' ] # openstackdocstheme options -repository_name = 'openstack/oslo.db' -bug_project = 'oslo.db' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.db' +openstackdocs_bug_project = 'oslo.db' +openstackdocs_bug_tag = '' # The master toctree document. master_doc = 'index' # General information about the project. -project = u'oslo.db' copyright = u'2014, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index bb7b35b..6ef9710 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -42,9 +42,9 @@ extensions = [ 'reno.sphinxext', ] # openstackdocstheme options -repository_name = 'openstack/oslo.db' -bug_project = 'oslo.db' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.db' +openstackdocs_bug_project = 'oslo.db' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] |