1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
import os
import sphinx.errors
import sys
import sphinx_rtd_theme
# 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
master_doc = "index"
project = "Tornado"
copyright = "The Tornado Authors"
version = release = tornado.version
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
]
primary_domain = "py"
default_role = "py:obj"
autodoc_member_order = "bysource"
autoclass_content = "both"
autodoc_inherit_docstrings = False
# Without this line sphinx includes a copy of object.__init__'s docstring
# on any class that doesn't define __init__.
# https://bitbucket.org/birkenfeld/sphinx/issue/1337/autoclass_content-both-uses-object__init__
autodoc_docstring_signature = False
coverage_skip_undoc_in_source = True
coverage_show_missing_items = True
coverage_ignore_modules = [
"tornado.curl_httpclient",
"tornado.platform.asyncio",
"tornado.platform.caresresolver",
"tornado.platform.twisted",
"tornado.simple_httpclient",
]
# I wish this could go in a per-module file...
coverage_ignore_classes = [
# tornado.gen
"Runner",
# tornado.web
"ChunkedTransferEncoding",
"GZipContentEncoding",
"OutputTransform",
"TemplateModule",
"url",
# tornado.websocket
"WebSocketProtocol",
"WebSocketProtocol13",
"WebSocketProtocol76",
]
coverage_ignore_functions = [
# various modules
"doctests",
"main",
# tornado.escape
# parse_qs_bytes should probably be documented but it's complicated by
# having different implementations between py2 and py3.
"parse_qs_bytes",
# tornado.gen
"Multi",
]
html_favicon = "favicon.ico"
latex_documents = [
(
"index",
"tornado.tex",
"Tornado Documentation",
"The Tornado Authors",
"manual",
False,
)
]
intersphinx_mapping = {"python": ("/usr/share/doc/python3-doc/html", None)}
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",
"unittest.case.TestCase",
"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",
"socket.AddressFamily",
"tornado.concurrent._T",
"tornado.gen._T",
"tornado.ioloop._S",
"tornado.ioloop._T",
"tornado.ioloop._Selectable",
"tornado.iostream._IOStreamType",
"tornado.locks._ReleasingContextManager",
"tornado.queues._T",
"tornado.options._Mockable",
"tornado.web._ArgDefaultMarker",
"tornado.web._HandlerDelegate",
"tornado.web._RequestHandlerType",
"_RequestHandlerType",
"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)
# Read the Docs configuration updates from
# https://about.readthedocs.com/blog/2024/07/addons-by-default/
# Define the canonical URL if you are using a custom domain on Read the Docs
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
# Tell Jinja2 templates the build is running on Read the Docs
if os.environ.get("READTHEDOCS", "") == "True":
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True
|
