openstack
/
openstack-helm-docs
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions 

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions 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: I324fa00ed82c82ebb6668784684a07b5febc71b8
This commit is contained in:
Andreas Jaeger 2020-05-31 20:26:32 +02:00
parent 856dd73aea
commit ec436cc34f
3 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/conf.py
View File

@ -27,8 +27,9 @@ release = ''
# -- General configuration ---------------------------------------------------
# OpenStackDocsTheme options
repository_name = 'openstack/openstack-helm-docs'
use_storyboard = True
openstackdocs_repo_name = 'openstack/openstack-helm-docs'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# If your documentation needs a minimal Sphinx version, state it here.
#
@ -66,7 +67,7 @@ language = None
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------

5
releasenotes/source/conf.py
View File

@ -24,8 +24,9 @@ copyright = '2018, OpenStack Developers'
author = 'OpenStack Helm Docs Authors'
# openstackdocstheme options
repository_name = 'openstack/openstack-helm-docs'
use_storyboard = True
openstackdocs_repo_name = 'openstack/openstack-helm-docs'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# The short X.Y version
version = ''

6
requirements.txt
View File

@ -3,8 +3,8 @@
# process, which may cause wedges in the gate later.
pbr>=2.0.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.31.2 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
# Releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0