add workaround comment

Signed-off-by: Ryan Northey <ryan@synca.io>
envoyproxy · Apr 26, 2021 · ce24661 · ce24661
1 parent 6306f63
commit ce24661
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/_ext/intersphinx_custom.py b/docs/_ext/intersphinx_custom.py
@@ -1,3 +1,16 @@
+#
+# This module has been copied from sphinx.ext in order to workaround a
+# sphinx issue described here:
+#     https://github.com/sphinx-doc/sphinx/issues/2068
+#
+# using the fix from:
+#     https://github.com/sphinx-doc/sphinx/pull/8981
+#
+# Once upstream is fixed this module should be removed.
+#
+# Envoy tracking bug is here:
+#     https://github.com/envoyproxy/envoy/issues/16181
+#
 """
     sphinx.ext.intersphinx
     ~~~~~~~~~~~~~~~~~~~~~~