openstack
/
python-cyborgclient
Code Issues Proposed changes

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.

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: I99b320c5dafffddf0390058bc112fd87b537420b
This commit is contained in:
Andreas Jaeger 2020-05-18 21:29:06 +02:00 committed by Andreas Jaeger
parent b7feb4ecf3
commit 2505c104b6
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -40,9 +40,9 @@ project = u'python-cyborgclient'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/python-cyborgclient'
bug_project = 'https://bugs.launchpad.net/python-cyborgclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-cyborgclient'
openstackdocs_bug_project = 'https://bugs.launchpad.net/python-cyborgclient'
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 --------------------------------------------------

8
releasenotes/source/conf.py
View File

@ -54,9 +54,9 @@ master_doc = 'index'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/python-cyborgclient'
bug_project = 'https://bugs.launchpad.net/python-cyborgclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-cyborgclient'
openstackdocs_bug_project = 'https://bugs.launchpad.net/python-cyborgclient'
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
@ -98,7 +98,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 = []

4
test-requirements.txt
View File

@ -10,7 +10,7 @@ sphinx>=2.0.0,!=2.1.0 # BSD
oslotest>=1.10.0 # Apache-2.0
stestr>=1.0.0 # Apache-2.0
testtools>=1.4.0 # MIT
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
requests-mock>=0.6.0 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0