diff options
author | Andreas Jaeger <aj@suse.com> | 2020-05-16 10:05:01 +0200 |
---|---|---|
committer | Andreas Jaeger <aj@suse.com> | 2020-05-18 20:54:49 +0200 |
commit | 39c29f6229863e1d31ce64f1aa59b3a359208a78 (patch) | |
tree | f0a4bd7c762725a0005d13ac24664a2e50c24f5f | |
parent | af6d26cee1a204d05c40ef9f8c5ac269d52a7e15 (diff) | |
download | oslo-vmware-39c29f6229863e1d31ce64f1aa59b3a359208a78.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: I6e7adce626eeba8010c915bf579b79e07ea645cf
-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 | 11 |
4 files changed, 10 insertions, 18 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 41665ed..a9033ab 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. # These are needed for docs generation -openstackdocstheme>=1.20.0 # Apache-2.0 -sphinx>=1.8.0,!=2.1.0 # 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 fixtures>=3.0.0 # Apache-2.0/BSD sphinxcontrib-apidoc>=0.2.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 8cece1b..d606cda 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,15 +22,14 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.vmware' -bug_project = 'oslo.vmware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.vmware' +openstackdocs_bug_project = 'oslo.vmware' +openstackdocs_bug_tag = '' # The master toctree document. master_doc = 'index' # General information about the project. -project = u'oslo.vmware' copyright = u'2014, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. diff --git a/lower-constraints.txt b/lower-constraints.txt index 2bd229a..94cb534 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -24,7 +24,6 @@ MarkupSafe==1.0 mccabe==0.2.1 netaddr==0.7.18 netifaces==0.10.4 -openstackdocstheme==1.20.0 oslo.concurrency==3.26.0 oslo.config==5.2.0 oslo.context==2.19.2 @@ -39,13 +38,10 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 requests==2.14.2 rfc3986==0.3.1 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.8.0 -sphinxcontrib-websupport==1.0.1 stestr==2.0.0 stevedore==1.20.0 suds-jurko==0.6 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 9b162b5..9245760 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -40,9 +40,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.vmware' -bug_project = 'oslo.vmware' -bug_tag = '' +openstackdocs_repo_name = 'openstack/oslo.vmware' +openstackdocs_bug_project = 'oslo.vmware' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -146,10 +147,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. # html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True |