openstack/os-vif
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

Update Sphinx version as well.

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: I612722e75975d6cfd5fc61037834b675117019e7
This commit is contained in:
Andreas Jaeger 2020-05-16 09:31:14 +02:00 committed by Andreas Jaeger
parent 64013a8609
commit 94f17912c5
4 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/requirements.txt
View File

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

8
doc/source/conf.py
View File

@ -23,9 +23,9 @@ extensions = [
] ]
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/os-vif' openstackdocs_repo_name = 'openstack/os-vif'
bug_project = 'os-vif' openstackdocs_bug_project = 'os-vif'
bug_tag = '' openstackdocs_bug_tag = ''
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
@ -44,7 +44,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------

6
lower-constraints.txt
View File

@ -34,7 +34,7 @@ msgpack-python==0.4.0
msgpack==0.5.6 msgpack==0.5.6
netaddr==0.7.18 netaddr==0.7.18
netifaces==0.10.6 netifaces==0.10.6
openstackdocstheme==1.20.0 openstackdocstheme==2.2.1
os-client-config==1.28.0 os-client-config==1.28.0
oslo.concurrency==3.20.0 oslo.concurrency==3.20.0
oslo.config==5.1.0 oslo.config==5.1.0
@ -69,14 +69,14 @@ python-mimeparse==1.6.0
python-subunit==1.0.0 python-subunit==1.0.0
pytz==2018.3 pytz==2018.3
PyYAML==3.12 PyYAML==3.12
reno==2.5.0 reno==3.1.0
repoze.lru==0.7 repoze.lru==0.7
requests==2.14.2 requests==2.14.2
requestsexceptions==1.2.0 requestsexceptions==1.2.0
rfc3986==1.1.0 rfc3986==1.1.0
Routes==2.4.1 Routes==2.4.1
snowballstemmer==1.2.1 snowballstemmer==1.2.1
Sphinx==1.6.2 Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1 sphinxcontrib-websupport==1.0.1
statsd==3.2.2 statsd==3.2.2
stestr==1.0.0 stestr==1.0.0

2
releasenotes/source/conf.py
View File

@ -40,7 +40,7 @@ release = ''
version = '' version = ''
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------