Skip to content

Commit 2612ba1

Browse files
committed
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
1 parent 9a2f2d4 commit 2612ba1

File tree

5 files changed

+14
-24
lines changed

5 files changed

+14
-24
lines changed

doc/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# The order of packages is significant, because pip processes them in the order
22
# of appearance. Changing the order has an impact on the overall integration
33
# process, which may cause wedges in the gate later.
4-
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
5-
reno>=2.7.0 # Apache-2.0
6-
openstackdocstheme>=1.18.1 # Apache-2.0
4+
sphinx>=2.0.0,!=2.1.0 # BSD
5+
reno>=3.1.0 # Apache-2.0
6+
openstackdocstheme>=2.2.1 # Apache-2.0

doc/source/conf.py

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode', 'openstackdocstheme']
1010

1111
# openstackdocstheme options
12-
repository_name = 'openstack/python-designateclient'
13-
bug_project = 'python-designateclient'
14-
bug_tag = ''
12+
openstackdocs_repo_name = 'openstack/python-designateclient'
13+
openstackdocs_bug_project = 'python-designateclient'
14+
openstackdocs_bug_tag = ''
1515
html_theme = 'openstackdocs'
1616

1717
# Add any paths that contain templates here, relative to this directory.
@@ -24,25 +24,14 @@
2424
master_doc = 'index'
2525

2626
# General information about the project.
27-
project = u'designateclient'
2827
copyright = u'2012, Managed I.T. 2013-2014, Hewlett-Packard Development Company, L.P.'
2928

30-
# The version info for the project you're documenting, acts as replacement for
31-
# |version| and |release|, also used in various other places throughout the
32-
# built documents.
33-
#
34-
# The short X.Y version.
35-
from designateclient.version import version_info as designateclient_version
36-
version = designateclient_version.canonical_version_string()
37-
# The full version, including alpha/beta/rc tags.
38-
release = designateclient_version.version_string_with_vcs()
39-
4029
# List of patterns, relative to source directory, that match files and
4130
# directories to ignore when looking for source files.
4231
exclude_patterns = []
4332

4433
# The name of the Pygments (syntax highlighting) style to use.
45-
pygments_style = 'sphinx'
34+
pygments_style = 'native'
4635

4736
# A list of ignored prefixes for module index sorting.
4837
modindex_common_prefix = ['designateclient']

lower-constraints.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ python-mimeparse==1.6.0
6060
python-subunit==1.0.0
6161
pytz==2013.6
6262
PyYAML==3.12
63-
reno==2.7.0
63+
reno==3.1.0
6464
requests==2.14.2
6565
requests-mock==1.2.0
6666
requestsexceptions==1.2.0

releasenotes/source/conf.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@
4242
]
4343

4444
# openstackdocstheme options
45-
repository_name = 'openstack/python-designateclient'
46-
bug_project = 'python-designateclient'
47-
bug_tag = ''
45+
openstackdocs_repo_name = 'openstack/python-designateclient'
46+
openstackdocs_bug_project = 'python-designateclient'
47+
openstackdocs_bug_tag = ''
48+
openstackdocs_auto_name = False
4849
html_theme = 'openstackdocs'
4950

5051
# Add any paths that contain templates here, relative to this directory.
@@ -99,7 +100,7 @@
99100
# show_authors = False
100101

101102
# The name of the Pygments (syntax highlighting) style to use.
102-
pygments_style = 'sphinx'
103+
pygments_style = 'native'
103104

104105
# A list of ignored prefixes for module index sorting.
105106
# modindex_common_prefix = []

test-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ os-testr>=1.0.0 # Apache-2.0
1010
python-subunit>=1.0.0 # Apache-2.0/BSD
1111
requests-mock>=1.2.0 # Apache-2.0
1212
stestr>=2.0.0 # Apache-2.0
13-
reno>=2.7.0 # Apache-2.0
13+
reno>=3.1.0 # Apache-2.0
1414
tempest>=17.1.0 # Apache-2.0

0 commit comments

Comments
 (0)