Switch to newer openstackdocstheme and reno versions

Switch to openstackdocstheme 2.2.0 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: I6bac230569a89c055115c852d5cc0cae027cddd8
This commit is contained in:
Andreas Jaeger 2020-05-18 21:30:02 +02:00
parent 9a2f2d4b9c
commit 2612ba13eb
5 changed files with 14 additions and 24 deletions

View File

@ -1,6 +1,6 @@
# 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!=1.6.6,!=1.6.7,>=1.6.2 # BSD
reno>=2.7.0 # Apache-2.0
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=3.1.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0

View File

@ -9,9 +9,9 @@
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'openstackdocstheme']
# openstackdocstheme options
repository_name = 'openstack/python-designateclient'
bug_project = 'python-designateclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-designateclient'
openstackdocs_bug_project = 'python-designateclient'
openstackdocs_bug_tag = ''
html_theme = 'openstackdocs'
# Add any paths that contain templates here, relative to this directory.
@ -24,25 +24,14 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'designateclient'
copyright = u'2012, Managed I.T. 2013-2014, Hewlett-Packard Development Company, L.P.'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
from designateclient.version import version_info as designateclient_version
version = designateclient_version.canonical_version_string()
# The full version, including alpha/beta/rc tags.
release = designateclient_version.version_string_with_vcs()
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# 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 = ['designateclient']

View File

@ -60,7 +60,7 @@ python-mimeparse==1.6.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
reno==2.7.0
reno==3.1.0
requests==2.14.2
requests-mock==1.2.0
requestsexceptions==1.2.0

View File

@ -42,9 +42,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/python-designateclient'
bug_project = 'python-designateclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-designateclient'
openstackdocs_bug_project = 'python-designateclient'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
html_theme = 'openstackdocs'
# Add any paths that contain templates here, relative to this directory.
@ -99,7 +100,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 = []

View File

@ -10,5 +10,5 @@ os-testr>=1.0.0 # Apache-2.0
python-subunit>=1.0.0 # Apache-2.0/BSD
requests-mock>=1.2.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
reno>=2.7.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
tempest>=17.1.0 # Apache-2.0