openstack/devstack
Code Issues Proposed changes

Switch to newer openstackdocstheme version

Browse Source 
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
This commit is contained in:
Andreas Jaeger 2020-05-19 08:40:52 +02:00 committed by Andreas Jaeger
parent 43c172acd0
commit 7f1a8c1c3e
2 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -2,8 +2,8 @@ pbr>=2.0.0,!=2.1.0
Pygments Pygments
docutils docutils
sphinx>=2.0.0,!=2.1.0 sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 openstackdocstheme>=2.2.1 # Apache-2.0
nwdiag nwdiag
blockdiag blockdiag
sphinxcontrib-blockdiag sphinxcontrib-blockdiag

14
doc/source/conf.py
View File

@ -30,9 +30,15 @@ extensions = [ 'sphinx.ext.autodoc',
'sphinxcontrib.nwdiag' ] 'sphinxcontrib.nwdiag' ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack-dev/devstack' openstackdocs_repo_name = 'openstack-dev/devstack'
bug_project = 'devstack' openstackdocs_pdf_link = True
bug_tag = '' openstackdocs_bug_project = 'devstack'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
# This repo is not tagged, so don't set versions
openstackdocs_auto_version = False
version = ''
release = ''
todo_include_todos = True todo_include_todos = True
@ -81,7 +87,7 @@ add_module_names = False
show_authors = False show_authors = False
# The name of the Pygments (syntax highlighting) style to use. # 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. # A list of ignored prefixes for module index sorting.
modindex_common_prefix = ['DevStack-doc.'] modindex_common_prefix = ['DevStack-doc.']