Skip to content

Docs: Unpin Sphinx #9311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bneradt merged 1 commit into from
Jan 17, 2023
Merged

Docs: Unpin Sphinx #9311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 2 additions & 10 deletions doc/Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,10 @@ verify_ssl = true

[packages]

# The latest 4.x sphinx release has issues with style rendering. The 3.x
# releases build and render fine, however. So we currently pin to that.
#
# Once that issue, either with sphinx or our docs, is resolved, then we should
# unpin sphinx by setting the following to "*".
sphinx = "==3.*"

# Sphinx 3.x builds break with the latest jinja2. This jinja2 pin can be
# removed when we move to Sphinx 4.x.
jinja2 = "<3.1"
sphinx = ">=6.x"

sphinx-rtd-theme = "*"
sphinxcontrib-jquery = "*"
sphinxcontrib-plantuml = "*"
# i18n
sphinx-intl = "*"
Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinxcontrib.plantuml',
'sphinxcontrib.jquery',
'traffic-server',
]

Expand Down
6 changes: 3 additions & 3 deletions doc/ext/traffic-server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ def run(self):
title['first'] = False
title['objtype'] = 'cv'
self.add_name(title)
title.set_class('ts-cv-title')
title['classes'].append('ts-cv-title')

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

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

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