Skip to content

Commit dd1fb2b

Browse files
bneradtzwoop
authored andcommitted
Docs: Unpin Sphinx (#9311)
When Sphinx 4.x was initially released there were rendering issues with it building the ATS docs. To address this we simply pinned to the 3.x releases. Currently the latest Sphinx release is v6.1.3 and I noticed that unpinning doesn't have issues with our code anymore. This therefore unpins Sphinx. This also addresses a deprecated use of set_class from traffic-server.py. (cherry picked from commit b2f2f00) Conflicts: doc/Pipfile
1 parent c26d71c commit dd1fb2b

File tree

3 files changed

+6
-15
lines changed

3 files changed

+6
-15
lines changed

doc/Pipfile

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,10 @@ verify_ssl = true
2323

2424
[packages]
2525

26-
# The latest 4.x sphinx release, currently 4.0.2, fails `make html`. For
27-
# details, see: https://github.com/apache/trafficserver/issues/7938
28-
#
29-
# The 3.x releases build fine, however. So we currently pin to that.
30-
#
31-
# Once that issue, either with sphinx or our docs, is resolved, then we should
32-
# unpin sphinx by setting the following to "*".
33-
sphinx = "==3.*"
34-
35-
# Sphinx 3.x builds break with the latest jinja2. This jinja2 pin can be
36-
# removed when we move to Sphinx 4.x.
37-
jinja2 = "<3.1"
26+
sphinx = ">=6.x"
3827

3928
sphinx-rtd-theme = "*"
29+
sphinxcontrib-jquery = "*"
4030
sphinxcontrib-plantuml = "*"
4131
# i18n
4232
sphinx-intl = "*"

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
'sphinx.ext.coverage',
6262
'sphinx.ext.viewcode',
6363
'sphinxcontrib.plantuml',
64+
'sphinxcontrib.jquery',
6465
'traffic-server',
6566
]
6667

doc/ext/traffic-server.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def run(self):
106106
title['first'] = False
107107
title['objtype'] = 'cv'
108108
self.add_name(title)
109-
title.set_class('ts-cv-title')
109+
title['classes'].append('ts-cv-title')
110110

111111
# Finally, add a desc_name() node to display the name of the
112112
# configuration variable.
@@ -115,7 +115,7 @@ def run(self):
115115
node.append(title)
116116

117117
if ('class' in self.options):
118-
title.set_class(self.options.get('class'))
118+
title['classes'].append(self.options.get('class'))
119119
# This has to be a distinct node before the title. if nested then
120120
# the browser will scroll forward to just past the title.
121121
nodes.target('', '', names=[cv_name])
@@ -244,7 +244,7 @@ def run(self):
244244
title['first'] = False
245245
title['objtype'] = 'stat'
246246
self.add_name(title)
247-
title.set_class('ts-stat-title')
247+
title['classes'].append('ts-stat-title')
248248

249249
# Finally, add a desc_name() node to display the name of the
250250
# configuration variable.

0 commit comments

Comments
 (0)