openstack
/
murano-dashboard
Code Issues Proposed changes

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.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Ifd0cbfb6e8ee1c6b998e73b3c6c4e922fe07841f
This commit is contained in:
Andreas Jaeger 2020-05-31 19:56:15 +02:00
parent 53fa7f95f1
commit f4fca35744
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -94,7 +94,7 @@ exclude_trees = ['api']
show_authors = True
# 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 = ['muranodashboard.']
@ -115,9 +115,9 @@ html_theme_path = ["."]
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/murano-dashboard'
bug_project = 'murano'
bug_tag = ''
openstackdocs_repo_name = 'openstack/murano-dashboard'
openstackdocs_bug_project = 'murano'
openstackdocs_bug_tag = ''
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

4
lower-constraints.txt
View File

@ -52,7 +52,7 @@ murano-pkg-check==0.3.0
netaddr==0.7.19
netifaces==0.10.6
nodeenv==0.9.4
openstackdocstheme==2.0.0
openstackdocstheme==2.2.1
openstacksdk==0.36.0
os-client-config==1.29.0
os-service-types==1.7.0
@ -95,7 +95,7 @@ python-swiftclient==3.5.0
pytz==2013.6
PyYAML==3.12
rcssmin==1.0.6
reno==2.5.0
reno==3.1.0
requests==2.18.4
requestsexceptions==1.4.0
rfc3986==1.1.0

8
releasenotes/source/conf.py
View File

@ -87,7 +87,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 = []
@ -103,9 +103,9 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/murano-dashboard'
bug_project = 'murano'
bug_tag = ''
openstackdocs_repo_name = 'openstack/murano-dashboard'
openstackdocs_bug_project = 'murano'
openstackdocs_bug_tag = ''
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

4
test-requirements.txt
View File

@ -11,9 +11,9 @@ selenium>=2.50.1 # Apache-2.0
# Docs Requirements
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
# Horizon requirements
django-compressor>=2.0 # MIT