openstack/python-zaqarclient
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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: Iafd5fb0f99a2b68c6f4a3118bf7d7c3a8881465f
This commit is contained in:
Andreas Jaeger 2020-05-19 08:09:05 +02:00 committed by Andreas Jaeger
parent 708b684e26
commit db7f5cd9fb
4 changed files with 12 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,8 +1,8 @@
# The order of packages is significant, because pip processes them in the order
# 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
sphinx>=2.0.0,!=2.1.0 # BSD
os-client-config>=1.28.0 # Apache-2.0
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
requests-mock>=1.2.0 # Apache-2.0

9
doc/source/conf.py
View File

@ -69,7 +69,6 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'zaqarclient'
copyright = u'2010-present, OpenStack Foundation'
# The language for content autogenerated by Sphinx. Refer to documentation
@ -108,7 +107,7 @@ add_module_names = False
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 = ['zaqarclient.']
@ -223,6 +222,6 @@ latex_documents = [
#latex_use_modindex = True
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-zaqarclient'
bug_project = 'python-zaqarclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-zaqarclient'
openstackdocs_bug_project = 'python-zaqarclient'
openstackdocs_bug_tag = ''

4
lower-constraints.txt
View File

@ -33,7 +33,6 @@ msgpack-python==0.4.0
munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.18.1
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -57,7 +56,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.2.0
requestsexceptions==1.2.0
@ -65,8 +63,6 @@ rfc3986==0.3.1
simplejson==3.5.1
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.5
sphinxcontrib-websupport==1.0.1
stestr==1.0.0
stevedore==1.20.0
termcolor==1.1.0

9
releasenotes/source/conf.py
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 = []
@ -271,6 +271,7 @@ texinfo_documents = [
locale_dirs = ['locale/']
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-zaqarclient'
bug_project = 'python-zaqarclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-zaqarclient'
openstackdocs_bug_project = 'python-zaqarclient'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False