Skip to content

Commit 7f1a8c1

Browse files
committed
Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using this version 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. Set openstackdocs_auto_version to not auto-version the documents. Set openstackdocs_auto_name to use 'project' as name. 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. 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: I26887b175b9c1ced7347289b7d5d4f57a20ec36a
1 parent 43c172a commit 7f1a8c1

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

doc/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ pbr>=2.0.0,!=2.1.0
22

33
Pygments
44
docutils
5-
sphinx>=2.0.0,!=2.1.0
6-
openstackdocstheme>=2.0.0
5+
sphinx>=2.0.0,!=2.1.0 # BSD
6+
openstackdocstheme>=2.2.1 # Apache-2.0
77
nwdiag
88
blockdiag
99
sphinxcontrib-blockdiag

doc/source/conf.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,15 @@
3030
'sphinxcontrib.nwdiag' ]
3131

3232
# openstackdocstheme options
33-
repository_name = 'openstack-dev/devstack'
34-
bug_project = 'devstack'
35-
bug_tag = ''
33+
openstackdocs_repo_name = 'openstack-dev/devstack'
34+
openstackdocs_pdf_link = True
35+
openstackdocs_bug_project = 'devstack'
36+
openstackdocs_bug_tag = ''
37+
openstackdocs_auto_name = False
38+
# This repo is not tagged, so don't set versions
39+
openstackdocs_auto_version = False
40+
version = ''
41+
release = ''
3642

3743
todo_include_todos = True
3844

@@ -81,7 +87,7 @@
8187
show_authors = False
8288

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

8692
# A list of ignored prefixes for module index sorting.
8793
modindex_common_prefix = ['DevStack-doc.']

0 commit comments

Comments
 (0)