diff options
author | Andreas Jaeger <aj@suse.com> | 2020-05-15 20:25:58 +0200 |
---|---|---|
committer | Andreas Jaeger <jaegerandi@gmail.com> | 2020-05-21 13:43:40 +0000 |
commit | 8c60d4261ed772df9b27230d1f07dfab846024ec (patch) | |
tree | f74ca8012a785238d98ce6f88418f0ad5e0c651e | |
parent | 6d80eba012cc768bb8768baaa7f5d2072180819c (diff) | |
download | oslo-i18n-8c60d4261ed772df9b27230d1f07dfab846024ec.tar.gz |
Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 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.
Set openstackdocs_auto_name to use project as name.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I129fcb2f17f7938b72fa788afa99004cc0be1d84
-rw-r--r-- | doc/requirements.txt | 6 | ||||
-rwxr-xr-x | doc/source/conf.py | 9 | ||||
-rw-r--r-- | lower-constraints.txt | 6 | ||||
-rw-r--r-- | releasenotes/source/conf.py | 10 |
4 files changed, 15 insertions, 16 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt index 970a9d3..3980781 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -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.1 # 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 02673cc..f107e39 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,10 +23,9 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.i18n' -bug_project = 'oslo.i18n' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/oslo.i18n' +openstackdocs_bug_project = 'oslo.i18n' +openstackdocs_bug_tag = '' # The master toctree document. master_doc = 'index' @@ -43,7 +42,7 @@ add_function_parentheses = True add_module_names = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # -- Options for HTML output -------------------------------------------------- diff --git a/lower-constraints.txt b/lower-constraints.txt index b3bca92..b6360d3 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -20,7 +20,7 @@ MarkupSafe==1.0 mccabe==0.2.1 mox3==0.20.0 netaddr==0.7.18 -openstackdocstheme==1.18.1 +openstackdocstheme==2.2.1 os-client-config==1.28.0 oslo.config==5.2.0 oslotest==3.2.0 @@ -32,14 +32,14 @@ python-mimeparse==1.6.0 python-subunit==1.0.0 pytz==2013.6 PyYAML==3.12 -reno==2.5.0 +reno==3.1.0 requests==2.14.2 requestsexceptions==1.2.0 rfc3986==0.3.1 six==1.10.0 smmap==0.9.0 snowballstemmer==1.2.1 -Sphinx==1.8.0 +Sphinx==2.0.0 sphinxcontrib-websupport==1.0.1 stestr==2.0.0 stevedore==1.20.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 3cfce5d..d5c4cb8 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -40,10 +40,10 @@ extensions = [ ] # openstackdocstheme options -repository_name = 'openstack/oslo.i18n' -bug_project = 'oslo.i18n' -bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +openstackdocs_repo_name = 'openstack/oslo.i18n' +openstackdocs_bug_project = 'oslo.i18n' +openstackdocs_bug_tag = '' +openstackdocs_auto_name = False # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -98,7 +98,7 @@ exclude_patterns = [] # show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] |