trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From zw...@apache.org
Subject [trafficserver] branch 9.0.x updated: Pin Sphinx to 3.x to unblock `make html` (#7987)
Date Wed, 30 Jun 2021 20:54:34 GMT
This is an automated email from the ASF dual-hosted git repository.

zwoop pushed a commit to branch 9.0.x
in repository https://gitbox.apache.org/repos/asf/trafficserver.git


The following commit(s) were added to refs/heads/9.0.x by this push:
     new 1e9fb86  Pin Sphinx to 3.x to unblock `make html` (#7987)
1e9fb86 is described below

commit 1e9fb8671a793130b9ab3db2268495154f3c1dd6
Author: Brian Neradt <brian.neradt@gmail.com>
AuthorDate: Wed Jun 30 15:54:24 2021 -0500

    Pin Sphinx to 3.x to unblock `make html` (#7987)
    
    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.
    
    This also makes a fix for an API change in which sphinx.locale no longer
    has `l_`.
---
 doc/Pipfile               | 11 ++++++++++-
 doc/ext/traffic-server.py |  2 +-
 2 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/doc/Pipfile b/doc/Pipfile
index f938473..42a9f5a 100644
--- a/doc/Pipfile
+++ b/doc/Pipfile
@@ -22,7 +22,16 @@ verify_ssl = true
 [dev-packages]
 
 [packages]
-sphinx = "2.0.1"
+
+# 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
diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
index 2033694..89b80d6 100644
--- a/doc/ext/traffic-server.py
+++ b/doc/ext/traffic-server.py
@@ -31,7 +31,7 @@ from docutils.parsers import rst
 from docutils.parsers.rst import directives
 from sphinx.domains import Domain, ObjType, std
 from sphinx.roles import XRefRole
-from sphinx.locale import l_, _
+from sphinx.locale import _
 import sphinx
 
 import subprocess

Mime
View raw message