openstack/oslo.i18n
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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
This commit is contained in:
Andreas Jaeger 2020-05-15 20:25:58 +02:00 committed by Andreas Jaeger
parent 6d80eba012
commit 8c60d4261e
4 changed files with 15 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -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

9
doc/source/conf.py
View File

@ -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 --------------------------------------------------

6
lower-constraints.txt
View File

@ -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

10
releasenotes/source/conf.py
View File

@ -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 = []