openstack/requirements
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: Iecd379c54ddbd4aedb45803897f33f31203b8048
This commit is contained in:
Andreas Jaeger 2020-06-01 15:49:24 +02:00
parent df9739531b
commit 78ae004de1
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -1,3 +1,3 @@
# this is required for the docs build jobs # this is required for the docs build jobs
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0 openstackdocstheme>=2.2.1 # Apache-2.0

9
doc/source/conf.py
View File

@ -69,15 +69,16 @@ 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 = ['requirements-doc.'] modindex_common_prefix = ['requirements-doc.']
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/requirements' openstackdocs_repo_name = 'openstack/requirements'
bug_project = 'openstack-requirements' openstackdocs_auto_name = False
bug_tag = '' openstackdocs_bug_project = 'openstack-requirements'
openstackdocs_bug_tag = ''
# -- Options for man page output ---------------------------------------------- # -- Options for man page output ----------------------------------------------
man_pages = [] man_pages = []