openstack/project-team-guide
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_version to not auto-version the documents.

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: I7ee87c4bd111935638dd74a277782a1f4d82e754
This commit is contained in:
Andreas Jaeger 2020-06-10 16:03:46 +02:00
parent 3ac4a40d2f
commit be9f8f1c7b
2 changed files with 10 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,4 +1,4 @@
pbr
openstackdocstheme>=1.32.1 # Apache-2.0
sphinx>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
doc8>=0.6.0 # Apache-2.0

12
doc/source/conf.py
View File

@ -31,10 +31,14 @@ extensions = ['sphinx.ext.todo',
'openstackdocstheme']
# openstackdocstheme options
repository_name = 'openstack/project-team-guide'
bug_project = 'openstack-manuals'
bug_tag = 'PTG'
openstackdocs_repo_name = 'openstack/project-team-guide'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'openstack-manuals'
openstackdocs_bug_tag = 'PTG'
html_theme = 'openstackdocs'
openstackdocs_auto_version = False
version = ''
release = ''
todo_include_todos = True
@ -84,7 +88,7 @@ add_module_names = False
show_authors = False
# 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.
modindex_common_prefix = ['project-team-guide.']