Browse Source

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.

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: I6c6775f75235dab2b9ed7820bfc5102bf5b04965
tags/3.1.0^0
Andreas Jaeger 1 month ago
parent
commit
9de5c99ccd
3 changed files with 8 additions and 8 deletions
  1. +4
    -4
      doc/source/conf.py
  2. +2
    -2
      lower-constraints.txt
  3. +2
    -2
      test-requirements.txt

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

@@ -81,7 +81,7 @@ exclude_patterns = ['_build']
#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 = []
@@ -241,6 +241,6 @@ texinfo_documents = [
#texinfo_no_detailmenu = False

# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/pycadf'
bug_project = 'pycadf'
bug_tag = ''
openstackdocs_repo_name = 'openstack/pycadf'
openstackdocs_bug_project = 'pycadf'
openstackdocs_bug_tag = ''

+ 2
- 2
lower-constraints.txt View File

@@ -22,7 +22,7 @@ mox3==0.20.0
msgpack-python==0.4.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.20.0
openstackdocstheme==2.2.1
os-client-config==1.28.0
oslo.config==5.2.0
oslo.i18n==3.15.3
@@ -44,7 +44,7 @@ requestsexceptions==1.2.0
rfc3986==0.3.1
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.2
Sphinx==2.0.0
sphinxcontrib-apidoc===0.2.0
sphinxcontrib-websupport==1.0.1
stevedore==1.20.0


+ 2
- 2
test-requirements.txt View File

@@ -12,6 +12,6 @@ stestr>=2.0.0 # Apache-2.0
testtools>=2.2.0 # MIT

# this is required for the docs build jobs
openstackdocstheme>=1.20.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD

Loading…
Cancel
Save