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: I614c930776145ab69a1b08d8affce43cae01f092
This commit is contained in:
Andreas Jaeger 2020-06-01 16:20:58 +02:00
parent b467b20b75
commit 47fa4f9e41
4 changed files with 16 additions and 14 deletions

View File

@ -46,9 +46,10 @@ project = 'compute-hyperv'
copyright = '2013, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/compute-hyperv'
bug_project = 'compute-hyperv'
bug_tag = ''
openstackdocs_repo_name = 'openstack/compute-hyperv'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'compute-hyperv'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -58,7 +59,7 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------

View File

@ -29,7 +29,7 @@ mox3==0.25.0
msgpack==0.5.6
netaddr==0.7.19
netifaces==0.10.6
openstackdocstheme==1.31.2
openstackdocstheme==2.2.1
os-brick==2.2.0
os-client-config==1.29.0
os-win==3.0.0
@ -58,7 +58,7 @@ python-mimeparse==1.6.0
python-subunit==1.0.0
pytz==2018.3
PyYAML==3.12
reno==2.5.0
reno==3.1.0
repoze.lru==0.7
requests==2.18.4
requestsexceptions==1.4.0
@ -67,7 +67,7 @@ rfc3986==1.1.0
Routes==2.4.1
six==1.11.0
snowballstemmer==1.2.1
Sphinx==1.6.2
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stestr==2.0.0
stevedore==1.28.0

View File

@ -56,9 +56,10 @@ project = u'compute_hyperv'
copyright = u'2017, Cloudbase Solutions'
# openstackdocstheme options
repository_name = 'openstack/compute-hyperv'
bug_project = 'compute-hyperv'
bug_tag = ''
openstackdocs_repo_name = 'openstack/compute-hyperv'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'compute-hyperv'
openstackdocs_bug_tag = ''
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@ -100,7 +101,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 = []

View File

@ -7,15 +7,15 @@ hacking>=3.0.1,<3.1.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
ddt>=1.0.1 # MIT
python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx>=1.6.2,!=1.6.6,!=1.6.7 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
oslo.config>=5.2.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
testtools>=2.2.0 # MIT
openstackdocstheme>=1.31.2 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
# placement functional tests
wsgi-intercept>=1.4.1 # MIT License
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0