conf.py 9.8 KB
Newer Older
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
#!/usr/bin/env python3
#
# PyTorch documentation build configuration file, created by
# sphinx-quickstart on Fri Dec 23 13:31:47 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
22

Brian Johnson's avatar
Brian Johnson committed
23
import pytorch_sphinx_theme
24
import torchvision
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
25
26
27
28


# -- General configuration ------------------------------------------------

29
# Required version of sphinx is set from docs/requirements.txt
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
30
31
32
33
34

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
35
36
37
38
39
40
41
42
43
44
45
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
    "sphinx.ext.mathjax",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinx.ext.duration",
    "sphinx_gallery.gen_gallery",
    "sphinx_copybutton",
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
46
47
]

48
sphinx_gallery_conf = {
49
50
51
52
    "examples_dirs": "../../gallery/",  # path to your example scripts
    "gallery_dirs": "auto_examples",  # path to where to save gallery generated output
    "backreferences_dir": "gen_modules/backreferences",
    "doc_module": ("torchvision",),
53
54
}

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
55
napoleon_use_ivar = True
56
57
napoleon_numpy_docstring = False
napoleon_google_docstring = True
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
58

59

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
60
# Add any paths that contain templates here, relative to this directory.
61
templates_path = ["_templates"]
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
62
63
64
65

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
66
source_suffix = {
67
    ".rst": "restructuredtext",
68
}
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
69
70

# The master toctree document.
71
master_doc = "index"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
72
73

# General information about the project.
74
75
76
project = "Torchvision"
copyright = "2017-present, Torch Contributors"
author = "Torch Contributors"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
77
78
79
80
81
82
83

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
# TODO: change to [:2] at v1.0
84
version = "main (" + torchvision.__version__ + " )"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
85
86
# The full version, including alpha/beta/rc tags.
# TODO: verify this works as expected
87
release = "main"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
88
89
90
91
92
93
94
95
96
97
98
99
100
101

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
102
pygments_style = "sphinx"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
103
104
105
106
107
108
109
110
111
112

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True


# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
113
html_theme = "pytorch_sphinx_theme"
Brian Johnson's avatar
Brian Johnson committed
114
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
115
116
117
118
119
120

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
121
122
123
124
125
126
    "collapse_navigation": False,
    "display_version": True,
    "logo_only": True,
    "pytorch_project": "docs",
    "navigation_with_keys": True,
    "analytics_id": "UA-117752657-2",
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
127
128
}

129
html_logo = "_static/img/pytorch-logo-dark.svg"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
130
131
132
133

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
134
html_static_path = ["_static"]
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
135

136
137
# TODO: remove this once https://github.com/pytorch/pytorch_sphinx_theme/issues/125 is fixed
html_css_files = [
138
    "css/custom_torchvision.css",
139
140
]

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
141
142
143
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
144
htmlhelp_basename = "PyTorchdoc"
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
145
146


147
148
149
autosummary_generate = True


Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

166

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
167
168
169
170
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
171
    (master_doc, "pytorch.tex", "torchvision Documentation", "Torch Contributors", "manual"),
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
172
173
174
175
176
177
178
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
179
man_pages = [(master_doc, "torchvision", "torchvision Documentation", [author], 1)]
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
180
181
182
183
184
185
186
187


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
188
189
190
191
192
193
194
195
196
    (
        master_doc,
        "torchvision",
        "torchvision Documentation",
        author,
        "torchvision",
        "One line description of project.",
        "Miscellaneous",
    ),
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
197
198
199
200
201
]


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
202
203
204
205
206
    "python": ("https://docs.python.org/", None),
    "torch": ("https://pytorch.org/docs/stable/", None),
    "numpy": ("http://docs.scipy.org/doc/numpy/", None),
    "PIL": ("https://pillow.readthedocs.io/en/stable/", None),
    "matplotlib": ("https://matplotlib.org/stable/", None),
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
207
208
209
210
211
212
213
}

# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
# See http://stackoverflow.com/a/41184353/3343043

from docutils import nodes
from sphinx import addnodes
214
from sphinx.util.docfields import TypedField
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
215
216
217
218
219
220


def patched_make_field(self, types, domain, items, **kw):
    # `kw` catches `env=None` needed for newer sphinx while maintaining
    #  backwards compatibility when passed along further down!

eellison's avatar
eellison committed
221
    # type: (list, unicode, tuple) -> nodes.field  # noqa: F821
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
222
223
    def handle_item(fieldarg, content):
        par = nodes.paragraph()
224
        par += addnodes.literal_strong("", fieldarg)  # Patch: this line added
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
225
226
227
        # par.extend(self.make_xrefs(self.rolename, domain, fieldarg,
        #                           addnodes.literal_strong))
        if fieldarg in types:
228
            par += nodes.Text(" (")
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
229
230
231
232
233
            # NOTE: using .pop() here to prevent a single type node to be
            # inserted twice into the doctree, which leads to
            # inconsistencies later when references are resolved
            fieldtype = types.pop(fieldarg)
            if len(fieldtype) == 1 and isinstance(fieldtype[0], nodes.Text):
234
235
236
237
238
239
                typename = "".join(n.astext() for n in fieldtype)
                typename = typename.replace("int", "python:int")
                typename = typename.replace("long", "python:long")
                typename = typename.replace("float", "python:float")
                typename = typename.replace("type", "python:type")
                par.extend(self.make_xrefs(self.typerolename, domain, typename, addnodes.literal_emphasis, **kw))
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
240
241
            else:
                par += fieldtype
242
243
            par += nodes.Text(")")
        par += nodes.Text(" -- ")
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
244
245
246
        par += content
        return par

247
    fieldname = nodes.field_name("", self.label)
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
248
249
250
251
252
253
    if len(items) == 1 and self.can_collapse:
        fieldarg, content = items[0]
        bodynode = handle_item(fieldarg, content)
    else:
        bodynode = self.list_type()
        for fieldarg, content in items:
254
255
256
            bodynode += nodes.list_item("", handle_item(fieldarg, content))
    fieldbody = nodes.field_body("", bodynode)
    return nodes.field("", fieldname, fieldbody)
Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
257

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
258

Sasank Chilamkurthy's avatar
Sasank Chilamkurthy committed
259
TypedField.make_field = patched_make_field
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288


def inject_minigalleries(app, what, name, obj, options, lines):
    """Inject a minigallery into a docstring.

    This avoids having to manually write the .. minigallery directive for every item we want a minigallery for,
    as it would be easy to miss some.

    This callback is called after the .. auto directives (like ..autoclass) have been processed,
    and modifies the lines parameter inplace to add the .. minigallery that will show which examples
    are using which object.

    It's a bit hacky, but not *that* hacky when you consider that the recommended way is to do pretty much the same,
    but instead with templates using autosummary (which we don't want to use):
    (https://sphinx-gallery.github.io/stable/configuration.html#auto-documenting-your-api-with-links-to-examples)

    For docs on autodoc-process-docstring, see the autodoc docs:
    https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
    """

    if what in ("class", "function"):
        lines.append(f".. minigallery:: {name}")
        lines.append(f"    :add-heading: Examples using ``{name.split('.')[-1]}``:")
        # avoid heading entirely to avoid warning. As a bonud it actually renders better
        lines.append("    :heading-level: 9")
        lines.append("\n")


def setup(app):
289
    app.connect("autodoc-process-docstring", inject_minigalleries)