From: Ben Darnell <ben@bendarnell.com>
Date: Sun, 1 Nov 2020 21:08:30 +0000 (-0500)
Subject: docs: Upgrade to latest version of sphinx
X-Git-Tag: v6.2.0b1~62^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e299a8b835135a9909c823408186dfb0539353e2;p=thirdparty%2Ftornado.git

docs: Upgrade to latest version of sphinx

This version attempts to resolve types found in type annotations,
but in many cases it can't find them so silence a bunch of warnings.
(Looks like deferred annotation processing will make this better but
we won't be able to use that until we drop Python 3.6)
---

diff --git a/docs/conf.py b/docs/conf.py
index f0cfa9c29..efa1c01d0 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,7 +1,8 @@
-# Ensure we get the local copy of tornado instead of what's on the standard path
 import os
+import sphinx.errors
 import sys
 
+# Ensure we get the local copy of tornado instead of what's on the standard path
 sys.path.insert(0, os.path.abspath(".."))
 import tornado
 
@@ -81,7 +82,7 @@ latex_documents = [
     )
 ]
 
-intersphinx_mapping = {"python": ("https://docs.python.org/3.6/", None)}
+intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
 
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
 
@@ -93,3 +94,50 @@ if not on_rtd:
 
     html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Suppress warnings about "class reference target not found" for these types.
+# In most cases these types come from type annotations and are for mypy's use.
+missing_references = {
+    # Generic type variables; nothing to link to.
+    "_IOStreamType",
+    "_S",
+    "_T",
+    # Standard library types which are defined in one module and documented
+    # in another. We could probably remap them to their proper location if
+    # there's not an upstream fix in python and/or sphinx.
+    "_asyncio.Future",
+    "_io.BytesIO",
+    "asyncio.AbstractEventLoop.run_forever",
+    "asyncio.events.AbstractEventLoop",
+    "concurrent.futures._base.Executor",
+    "concurrent.futures._base.Future",
+    "futures.Future",
+    "socket.socket",
+    "TextIO",
+    # Other stuff. I'm not sure why some of these are showing up, but
+    # I'm just listing everything here to avoid blocking the upgrade of sphinx.
+    "Future",
+    "httputil.HTTPServerConnectionDelegate",
+    "httputil.HTTPServerRequest",
+    "OutputTransform",
+    "Pattern",
+    "RAISE",
+    "Rule",
+    "tornado.ioloop._Selectable",
+    "tornado.locks._ReleasingContextManager",
+    "tornado.options._Mockable",
+    "tornado.web._ArgDefaultMarker",
+    "tornado.web._HandlerDelegate",
+    "traceback",
+    "WSGIAppType",
+    "Yieldable",
+}
+
+
+def missing_reference_handler(app, env, node, contnode):
+    if node["reftarget"] in missing_references:
+        raise sphinx.errors.NoUri
+
+
+def setup(app):
+    app.connect("missing-reference", missing_reference_handler)
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 7599072be..03e5a6923 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,4 @@
-sphinx>1.8.2,<2.1
-sphinxcontrib-asyncio==0.2.0
+sphinx
+sphinxcontrib-asyncio
 sphinx_rtd_theme
 Twisted