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.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

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.

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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I4fe9ea8ee88dad673849cbb9e1a469ca12705740
This commit is contained in:
Andreas Jaeger 2020-05-18 22:03:43 +02:00 committed by Andreas Jaeger
parent 2be7ebacfc
commit fc9b08fc6e
4 changed files with 10 additions and 14 deletions

View File

@ -2,5 +2,5 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0

View File

@ -45,7 +45,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 --------------------------------------------------
@ -58,9 +58,9 @@ html_theme = 'openstackdocs'
#html_theme_path = [openstackdocstheme.get_html_theme_path()]
# openstackdocstheme options
repository_name = 'openstack/python-muranoclient'
bug_project = 'python-muranoclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-muranoclient'
openstackdocs_bug_project = 'python-muranoclient'
openstackdocs_bug_tag = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'python-muranoclientdoc'

View File

@ -39,7 +39,6 @@ munch==2.1.0
murano-pkg-check==0.3.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==2.0.0
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -74,7 +73,6 @@ python-mimeparse==1.6.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
requests==2.14.2
requests-mock==1.1.0
requestsexceptions==1.2.0
@ -82,8 +80,6 @@ rfc3986==0.3.1
semantic-version==2.3.1
simplejson==3.5.1
snowballstemmer==1.2.1
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stevedore==1.20.0
tempest==17.1.0
stestr==2.0.0

View File

@ -93,7 +93,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 = []
@ -118,9 +118,9 @@ html_theme = 'openstackdocs'
# html_theme_path = [openstackdocstheme.get_html_theme_path()]
# openstackdocstheme options
repository_name = 'openstack/python-muranoclient'
bug_project = 'python-muranoclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-muranoclient'
openstackdocs_bug_project = 'python-muranoclient'
openstackdocs_bug_tag = ''
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".