Skip to content

Commit 5ea0940

Browse files
committed
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. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Disable openstackdocs_auto_name to use 'project' variable 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. 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: I649b1b74cd8542bd5870938f3bc74e296df7a04e
1 parent 17bd8df commit 5ea0940

File tree

3 files changed

+12
-30
lines changed

3 files changed

+12
-30
lines changed

doc/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# of appearance. Changing the order has an impact on the overall integration
33
# process, which may cause wedges in the gate later.
44

5-
openstackdocstheme>=1.30.0 # Apache-2.0
6-
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
5+
openstackdocstheme>=2.2.1 # Apache-2.0
6+
sphinx>=2.0.0,!=2.1.0 # BSD
77
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
8-
reno>=2.5.0 # Apache-2.0
8+
reno>=3.1.0 # Apache-2.0
99

doc/source/conf.py

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,6 @@
5252
project = u'cloudkitty-dashboard'
5353
copyright = u'2014, Objectif Libre'
5454

55-
# The version info for the project you're documenting, acts as replacement for
56-
# |version| and |release|, also used in various other places throughout the
57-
# built documents.
58-
#
59-
# The short X.Y version.
60-
version = '0.1'
61-
# The full version, including alpha/beta/rc tags.
62-
release = '0.1'
63-
6455
# The language for content autogenerated by Sphinx. Refer to documentation
6556
# for a list of supported languages.
6657
#language = None
@@ -91,7 +82,7 @@
9182
#show_authors = False
9283

9384
# The name of the Pygments (syntax highlighting) style to use.
94-
pygments_style = 'sphinx'
85+
pygments_style = 'native'
9586

9687
# A list of ignored prefixes for module index sorting.
9788
#modindex_common_prefix = []
@@ -141,11 +132,6 @@
141132
# directly to the root of the documentation.
142133
#html_extra_path = []
143134

144-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
145-
# using the given strftime format.
146-
#html_last_updated_fmt = '%b %d, %Y'
147-
html_last_updated_fmt = '%Y-%m-%d %H:%M'
148-
149135
# If true, SmartyPants will be used to convert quotes and dashes to
150136
# typographically correct entities.
151137
#html_use_smartypants = True
@@ -283,6 +269,7 @@
283269
#texinfo_no_detailmenu = False
284270

285271
# -- Options for openstackdocstheme -------------------------------------------
286-
repository_name = 'openstack/cloudkitty-dashboard'
287-
bug_project = '891'
288-
bug_tag = 'doc'
272+
openstackdocs_repo_name = 'openstack/cloudkitty-dashboard'
273+
openstackdocs_pdf_link = True
274+
openstackdocs_auto_name = False
275+
openstackdocs_use_storyboard = True

releasenotes/source/conf.py

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
#show_authors = False
8282

8383
# The name of the Pygments (syntax highlighting) style to use.
84-
pygments_style = 'sphinx'
84+
pygments_style = 'native'
8585

8686
# A list of ignored prefixes for module index sorting.
8787
#modindex_common_prefix = []
@@ -130,11 +130,6 @@
130130
# directly to the root of the documentation.
131131
#html_extra_path = []
132132

133-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134-
# using the given strftime format.
135-
#html_last_updated_fmt = '%b %d, %Y'
136-
html_last_updated_fmt = '%Y-%m-%d %H:%M'
137-
138133
# If true, SmartyPants will be used to convert quotes and dashes to
139134
# typographically correct entities.
140135
#html_use_smartypants = True
@@ -257,9 +252,9 @@
257252
#texinfo_no_detailmenu = False
258253

259254
# -- Options for openstackdocstheme -------------------------------------------
260-
repository_name = 'openstack/cloudkitty-dashboard'
261-
bug_project = '891'
262-
bug_tag = 'doc'
255+
openstackdocs_repo_name = 'openstack/cloudkitty-dashboard'
256+
openstackdocs_auto_name = False
257+
openstackdocs_use_storyboard = True
263258

264259
# -- Options for Internationalization output ------------------------------
265260
locale_dirs = ['locale/']

0 commit comments

Comments
 (0)