Skip to content

Commit faf6e16

Browse files
committed
Use openstackdocstheme in release note
In the release notes build, openstackdocstheme is specified in the sphinx extension list, but it is actually not used. This commit configures openstackdocstheme as suggested in the openstackdocstheme document. Also specifies display_toc False in html_theme_options. This prevents openstackdocstheme to add the local TOC automatically. OSC has several releases during a single development cycle and it leads to a long TOC at the top of individual pages. It loses the readability and we can see version numbers in the left sidebar, so we can safely disable the local TOC in the release notes. [1] https://docs.openstack.org/openstackdocstheme/latest/ Change-Id: Iae08d309f7589bb13a1766f6fded70673ba24047
1 parent 91cc731 commit faf6e16

1 file changed

Lines changed: 9 additions & 2 deletions

File tree

releasenotes/source/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@
4343
'sphinx.ext.extlinks',
4444
]
4545

46+
# openstackdocstheme options
47+
repository_name = 'openstack/python-openstackclient'
48+
bug_project = 'python-openstackclient'
49+
bug_tag = ''
50+
4651
# Set aliases for extlinks
4752
# * lpbug - generic Launchpad bug :lpbug:`123456`
4853
# * oscbp - OSC blueprints :oscbp:`Blue Print <bp-name>`
@@ -132,12 +137,14 @@
132137

133138
# The theme to use for HTML and HTML Help pages. See the documentation for
134139
# a list of builtin themes.
135-
html_theme = 'default'
140+
html_theme = 'openstackdocs'
136141

137142
# Theme options are theme-specific and customize the look and feel of a theme
138143
# further. For a list of options available for each theme, see the
139144
# documentation.
140-
# html_theme_options = {}
145+
html_theme_options = {
146+
'display_toc': False,
147+
}
141148

142149
# Add any paths that contain custom themes here, relative to this directory.
143150
# html_theme_path = []

0 commit comments

Comments
 (0)