openstack/kuryr
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.

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.

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.

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

Change-Id: I9845c13f4d87c755c56922d3a7fba9a8adfbfb18
This commit is contained in:
Andreas Jaeger 2020-05-30 18:38:17 +02:00
parent 0f47555b38
commit 8aeaf7e98e
4 changed files with 11 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -1,3 +1,3 @@
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD

8
doc/source/conf.py
View File

@ -40,9 +40,9 @@ master_doc = 'index'
copyright = u'2013, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/kuryr'
bug_project = 'kuryr'
bug_tag = ''
openstackdocs_repo_name = 'openstack/kuryr'
openstackdocs_bug_project = 'kuryr'
openstackdocs_bug_tag = ''
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -52,7 +52,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 --------------------------------------------------

4
lower-constraints.txt
View File

@ -45,7 +45,6 @@ munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
neutron-lib==1.13.0
openstackdocstheme==1.20.0
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0
@ -87,7 +86,6 @@ python-neutronclient==6.7.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
repoze.lru==0.7
requests==2.14.2
requestsexceptions==1.2.0
@ -96,8 +94,6 @@ Routes==2.3.1
simplejson==3.5.1
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.2
sphinxcontrib-websupport==1.0.1
SQLAlchemy==1.0.10
sqlalchemy-migrate==0.11.0
sqlparse==0.2.2

8
releasenotes/source/conf.py
View File

@ -54,9 +54,9 @@ master_doc = 'index'
copyright = u'2016, Kuryr developers'
# openstackdocstheme options
repository_name = 'openstack/kuryr'
bug_project = 'kuryr'
bug_tag = ''
openstackdocs_repo_name = 'openstack/kuryr'
openstackdocs_bug_project = 'kuryr'
openstackdocs_bug_tag = ''
# Release notes do not need a version number in the title, they
# cover multiple releases.
@ -106,7 +106,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 = []