openstack/trove-specs
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.

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: Ibc047f8a603fd81b32e3e4dd29a9eab283cc1048
This commit is contained in:
Andreas Jaeger 2020-06-01 16:12:32 +02:00
parent b3a0be6eaa
commit 09b0eaace5
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/source/conf.py
View File

@ -29,9 +29,10 @@ extensions = [
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/trove-specs' openstackdocs_repo_name = 'openstack/trove-specs'
bug_project = 'trove-specs' openstackdocs_auto_name = False
bug_tag = 'doc' openstackdocs_bug_project = 'trove-specs'
openstackdocs_bug_tag = 'doc'
# Optionally allow the use of sphinxcontrib.spelling to verify the # Optionally allow the use of sphinxcontrib.spelling to verify the
# spelling of the documents. # spelling of the documents.
@ -67,7 +68,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# 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'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------

2
requirements.txt
View File

@ -1,4 +1,4 @@
openstackdocstheme>=2.0.0 openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
testrepository>=0.0.18 testrepository>=0.0.18
testtools>=0.9.34 testtools>=0.9.34