diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-05-16 09:42:09 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-05-18 20:56:38 +0200 |
| commit | b3b1bd0d44202906e07e9ac3668992f5f4e42dad (patch) | |
| tree | 5c1ab9c2af980a5d74b56dfb18c3a13cc475192b | |
| parent | 0625035e9fb2e2844e33ce6e3dc8c097f3e3d667 (diff) | |
| download | oslo-policy-b3b1bd0d44202906e07e9ac3668992f5f4e42dad.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
Update Sphinx version as well.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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: I565a343d875cea144928da007a93f0b93a5d4274
| -rw-r--r-- | doc/requirements.txt | 6 | ||||
| -rw-r--r-- | doc/source/conf.py | 7 | ||||
| -rw-r--r-- | lower-constraints.txt | 4 | ||||
| -rw-r--r-- | releasenotes/source/conf.py | 6 |
4 files changed, 9 insertions, 14 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 9cf3697..3882a1e 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,8 +2,8 @@ # 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 sphinxcontrib-apidoc>=0.2.0 # BSD -reno>=2.5.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index c2b91e4..201bb96 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,9 +25,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.policy' -bug_project = 'oslo.policy' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.policy' +openstackdocs_bug_project = 'oslo.policy' +openstackdocs_bug_tag = '' # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. @@ -40,7 +40,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'oslo.policy' copyright = u'2014, OpenStack Foundation' source_tree = 'https://opendev.org/openstack/oslo.policy/src/branch/master' diff --git a/lower-constraints.txt b/lower-constraints.txt index 5b0949e..e92698b 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -23,7 +23,6 @@ mox3==0.20.0 msgpack-python==0.4.0 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.20.0 os-client-config==1.28.0 oslo.config==5.2.0 oslo.context==2.22.0 @@ -40,7 +39,6 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 requests==2.14.2 requests-mock==1.2.0 requestsexceptions==1.2.0 @@ -49,8 +47,6 @@ six==1.10.0 stestr==2.0.0 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.8.0 -sphinxcontrib-websupport==1.0.1 stevedore==1.20.0 testrepository==0.0.18 testtools==2.2.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 5084a9d..b72c0a4 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -40,9 +40,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.policy' -bug_project = 'oslo.policy' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.policy' +openstackdocs_bug_project = 'oslo.policy' +openstackdocs_bug_tag = '' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] |