openstack
/
openstack-chef
Code Issues Proposed changes

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.

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: Ied3bb008208231bd4c9b6c2e86c716eac66267aa
This commit is contained in:
Andreas Jaeger 2020-05-31 20:21:24 +02:00
parent 81249f67cb
commit b27b5edcbc
3 changed files with 14 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
deploy-guide/source/conf.py
View File

@ -56,20 +56,12 @@ master_doc = 'index'
# General information about the project.
project = u'Deployment Guide for OpenStack Chef Cookbooks'
repository_name = 'openstack/openstack-chef'
bug_project = 'openstack-chef'
bug_tag = u'deploy-guide'
openstackdocs_repo_name = 'openstack/openstack-chef'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'openstack-chef'
openstackdocs_bug_tag = u'deploy-guide'
copyright = u'2019, OpenStack contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.1'
# The full version, including alpha/beta/rc tags.
release = '0.1'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -100,7 +92,7 @@ exclude_patterns = ["common_prerequisites.rst", "common_configure.rst"]
# 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 = []

6
doc/requirements.txt
View File

@ -3,6 +3,6 @@
# process, which may cause wedges in the gate later.
# this is required for the docs build jobs
sphinx>=1.8.0,!=2.1.0 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0

11
doc/source/conf.py
View File

@ -49,9 +49,10 @@ source_suffix = '.rst'
master_doc = 'index'
# openstackdocstheme options
repository_name = 'openstack/openstack-chef'
bug_project = 'openstack-chef'
bug_tag = ''
openstackdocs_repo_name = 'openstack/openstack-chef'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'openstack-chef'
openstackdocs_bug_tag = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -66,7 +67,7 @@ language = None
exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@ -155,7 +156,7 @@ man_pages = [
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, target_name,
title, author, bug_project,
title, author, openstackdocs_bug_project,
description, category),
]