Browse Source

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: I8e29f5bcf3a4a32d691bb2d2f1b83907cbb71c0f
changes/70/732570/1
Andreas Jaeger 1 month ago
parent
commit
3b8ab1f369
2 changed files with 7 additions and 7 deletions
  1. +3
    -3
      doc/requirements.txt
  2. +4
    -4
      releasenotes/source/conf.py

+ 3
- 3
doc/requirements.txt View File

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

# This is required for the releasenotes build jobs
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0

+ 4
- 4
releasenotes/source/conf.py View File

@@ -86,7 +86,7 @@ exclude_patterns = []
#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 = []
@@ -250,6 +250,6 @@ texinfo_documents = [
locale_dirs = ['locale/']

# openstackdocstheme options
repository_name = 'openstack/puppet-ceph'
bug_project = 'puppet-ceph'
bug_tag = ''
openstackdocs_repo_name = 'openstack/puppet-ceph'
openstackdocs_bug_project = 'puppet-ceph'
openstackdocs_bug_tag = ''

Loading…
Cancel
Save