1. devstack
  2. Commit 7f1a8c1c3edb532c1cc69fba74055ba58117b21c
Browse code

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

Andreas Jaeger authored on 2020/05/19 15:40:52
Showing 2 changed files
doc/requirements.txt
History View file @ 7f1a8c1
... ... 
@@ -2,8 +2,8 @@ pbr>=2.0.0,!=2.1.0
2 2
3 3 
 Pygments
4 4 
 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
7 7 
 nwdiag
8 8 
 blockdiag
9 9 
 sphinxcontrib-blockdiag
doc/source/conf.py
History View file @ 7f1a8c1
... ... 
@@ -30,9 +30,15 @@ extensions = [ 'sphinx.ext.autodoc',
30 30 
                'sphinxcontrib.nwdiag' ]
31 31
32 32 
 # 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 = ''
36 42
37 43 
 todo_include_todos = True
38 44
... ... 
@@ -81,7 +87,7 @@ add_module_names = False
81 81 
 show_authors = False
82 82
83 83 
 # The name of the Pygments (syntax highlighting) style to use.
84 
-pygments_style = 'sphinx'
84 
+pygments_style = 'native'
85 85
86 86 
 # A list of ignored prefixes for module index sorting.
87 87 
 modindex_common_prefix = ['DevStack-doc.']