This is an automated email from the ASF dual-hosted git repository.
zwoop pushed a commit to branch 9.1.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/9.1.x by this push:
new 5c72845 Pin Sphinx to 3.x to unblock `make html` (#7940)
5c72845 is described below
commit 5c72845777ac27ba6415ad053457b7232e387377
Author: Brian Neradt <[email protected]>
AuthorDate: Fri Jun 11 16:24:41 2021 -0500
Pin Sphinx to 3.x to unblock `make html` (#7940)
The latest version of Sphinx, 4.0.2, fails to build our docs via the
`make html` target. The latest 3.x release, currently 3.5.4, builds our
docs fine. Pinning to 3.x.
(cherry picked from commit 3d584af796bad1e9e3c03b2af5485b630ffedafb)
---
doc/Pipfile | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/doc/Pipfile b/doc/Pipfile
index 78be762..42a9f5a 100644
--- a/doc/Pipfile
+++ b/doc/Pipfile
@@ -22,7 +22,16 @@ verify_ssl = true
[dev-packages]
[packages]
-sphinx = "*"
+
+# The latest 4.x sphinx release, currently 4.0.2, fails `make html`. For
+# details, see: https://github.com/apache/trafficserver/issues/7938
+#
+# The 3.x releases build 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-rtd-theme = "*"
sphinxcontrib-plantuml = "*"
# i18n
