conf.py 11.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# 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.
#
20
import os
moto's avatar
moto committed
21
22
23
import sys

sys.path.insert(0, os.path.abspath("."))
24
import re
25
import warnings
moto's avatar
moto committed
26
from datetime import datetime
27

28
import pytorch_sphinx_theme
29
30
31

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

32
warnings.filterwarnings("ignore", module=r"matplotlib\..*")
33
34


35
36
# If your documentation needs a minimal Sphinx version, state it here.
#
37
needs_sphinx = "1.6"
38
39
40
41
42

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
43
44
45
46
47
48
49
50
51
52
53
    "sphinx.ext.autodoc",
    "sphinx.ext.autosummary",
    "sphinx.ext.doctest",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
    "sphinx.ext.coverage",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinxcontrib.katex",
    "sphinxcontrib.bibtex",
    "sphinx_gallery.gen_gallery",
54
55
]

moto's avatar
moto committed
56
57
autodoc_member_order = "bysource"

58
59
60
61
# katex options
#
#

62
katex_options = r"""
63
64
65
66
67
delimiters : [
   {left: "$$", right: "$$", display: true},
   {left: "\\(", right: "\\)", display: false},
   {left: "\\[", right: "\\]", display: true}
]
68
"""
69

70
bibtex_bibfiles = ["refs.bib"]
moto's avatar
moto committed
71

72
73
74
75
76

def _get_var(var, default=False):
    if var not in os.environ:
        return default

77
78
79
    val = os.environ.get(var, "0")
    trues = ["1", "true", "TRUE", "on", "ON", "yes", "YES"]
    falses = ["0", "false", "FALSE", "off", "OFF", "no", "NO"]
80
81
82
83
    if val in trues:
        return True
    if val not in falses:
        print(
84
85
            f" --- WARNING: Unexpected environment variable value `{var}={val}`. " f"Expected one of {trues + falses}"
        )
86
87
88
89
    return False


def _get_pattern():
90
    pattern = os.getenv("GALLERY_PATTERN")
91
92
93
94
95
    # If BUILD_GALLERY is falsy -> no build
    # If BUILD_GALLERY is truey -> build
    # If BUILD_GALLERY is undefined
    #    If GALLERY_PATTERN is defined     -> build
    #    If GALLERY_PATTERN is not defined -> not build
96
    if not _get_var("BUILD_GALLERY", default=False if pattern is None else True):
97
98
99
        if pattern is not None:
            print(
                ' --- WARNING: "GALLERY_PATTERN" is provided, but "BUILD_GALLERY" value is falsy. '
100
                "Sphinx galleries are not built. To build galleries, set `BUILD_GALLERY=1`."
101
102
            )
        return {
103
            "ignore_pattern": r"\.py",
104
105
        }

106
107
    ret = {"filename_pattern": "tutorial.py"}
    if os.getenv("GALLERY_PATTERN"):
108
        # See https://github.com/pytorch/tutorials/blob/cbf2238df0e78d84c15bd94288966d2f4b2e83ae/conf.py#L75-L83
109
        ret["ignore_pattern"] = r"/(?!" + re.escape(os.getenv("GALLERY_PATTERN")) + r")[^/]+$"
110
111
112
    return ret


moto's avatar
moto committed
113
sphinx_gallery_conf = {
114
115
    "examples_dirs": [
        "../../examples/tutorials",
moto's avatar
moto committed
116
    ],
117
118
    "gallery_dirs": [
        "tutorials",
moto's avatar
moto committed
119
    ],
120
    **_get_pattern(),
121
122
123
    "backreferences_dir": "gen_modules/backreferences",
    "first_notebook_cell": None,
    "doc_module": ("torchaudio",),
moto's avatar
moto committed
124
125
126
}
autosummary_generate = True

127
napoleon_use_ivar = True
128
129
napoleon_numpy_docstring = False
napoleon_google_docstring = True
130
131

# Add any paths that contain templates here, relative to this directory.
132
templates_path = ["_templates"]
133
134
135
136
137

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
138
source_suffix = ".rst"
139
140

# The master toctree document.
141
master_doc = "index"
142
143

# General information about the project.
144
project = "Torchaudio"
moto's avatar
moto committed
145
copyright = f"{datetime.now().year}, Torchaudio Contributors"
146
author = "Torchaudio Contributors"
147
148
149
150
151

# 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.
#
moto's avatar
moto committed
152
153
154
155
156
157
158
159
160
# `version` is visible from users
# `release` is used for metadata
if os.getenv("BUILD_VERSION"):
    version = release = os.environ["BUILD_VERSION"]
else:
    import torchaudio

    version = f"Nightly Build ({torchaudio.__version__})"
    release = "nightly"
161
162
163
164
165
166
167
168
169
170
171

# 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
172
exclude_patterns = ["*/index.rst"]
173
174

# The name of the Pygments (syntax highlighting) style to use.
175
pygments_style = "sphinx"
176
177
178
179
180
181
182
183
184
185

# 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.
#
186
html_theme = "pytorch_sphinx_theme"
187
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
188
189
190
191
192
193

# 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 = {
194
195
196
197
198
199
    "pytorch_project": "audio",
    "collapse_navigation": False,
    "display_version": True,
    "logo_only": True,
    "navigation_with_keys": True,
    "analytics_id": "UA-117752657-2",
200
201
}

202
html_logo = "_static/img/pytorch-logo-dark.svg"
203
204
205
206

# 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".
207
html_static_path = ["_static"]
208
html_css_files = ["https://cdn.jsdelivr.net/npm/katex@0.10.0-beta/dist/katex.min.css", "css/custom.css"]
209
210
211
212

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
213
htmlhelp_basename = "TorchAudiodoc"
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236


# -- 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',
}

# 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 = [
237
    (master_doc, "pytorch.tex", "Torchaudio Documentation", "Torch Contributors", "manual"),
238
239
240
241
242
243
244
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
245
man_pages = [(master_doc, "Torchaudio", "Torchaudio Documentation", [author], 1)]
246
247
248
249
250
251
252
253


# -- 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 = [
254
255
256
257
258
259
260
261
262
    (
        master_doc,
        "Torchaudio",
        "Torchaudio Documentation",
        author,
        "Torchaudio",
        "Load audio files into pytorch tensors.",
        "Miscellaneous",
    ),
263
264
265
266
267
]


# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
268
269
270
    "python": ("https://docs.python.org/3/", None),
    "numpy": ("https://numpy.org/doc/stable/", None),
    "torch": ("https://pytorch.org/docs/stable/", None),
271
272
273
274
275
276
277
}

# -- 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
278
from sphinx.util.docfields import TypedField
279
280
281
282
283
284


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!

Rahul Amaram's avatar
Rahul Amaram committed
285
    # type: (list, str, tuple) -> nodes.field
286
287
    def handle_item(fieldarg, content):
        par = nodes.paragraph()
288
        par += addnodes.literal_strong("", fieldarg)  # Patch: this line added
289
290
291
        # par.extend(self.make_xrefs(self.rolename, domain, fieldarg,
        #                           addnodes.literal_strong))
        if fieldarg in types:
292
            par += nodes.Text(" (")
293
294
295
296
297
            # 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):
298
299
300
301
302
303
                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))
304
305
            else:
                par += fieldtype
306
307
            par += nodes.Text(")")
        par += nodes.Text(" -- ")
308
309
310
        par += content
        return par

311
    fieldname = nodes.field_name("", self.label)
312
313
314
315
316
317
    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:
318
319
320
321
            bodynode += nodes.list_item("", handle_item(fieldarg, content))
    fieldbody = nodes.field_body("", bodynode)
    return nodes.field("", fieldname, fieldbody)

322
323

TypedField.make_field = patched_make_field
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344


# Based off of
# https://github.com/sphinx-gallery/sphinx-gallery/blob/5b21962284f865beeaeb79cca50c8c394fa60cba/sphinx_gallery/directives.py#L66-L70
def _has_backref(obj):
    this_dir = os.path.dirname(__file__)
    path = os.path.join(this_dir, "gen_modules", "backreferences", f"{obj}.examples")
    return os.path.isfile(path) and os.path.getsize(path) > 0


# Based off of
# https://github.com/pytorch/vision/blob/5335006be7ef01c9f6cb700fe793d7c645e83e84/docs/source/conf.py#L262
def inject_minigalleries(app, what, name, obj, options, lines):
    if what in ("class", "function") and _has_backref(name):
        lines.append(f"Tutorials using ``{name.split('.')[-1]}``:")
        lines.append(f"    .. minigallery:: {name}")
        lines.append("\n")


def setup(app):
    app.connect("autodoc-process-docstring", inject_minigalleries)
moto's avatar
moto committed
345
346
347
348
349
350
351
352
353
354


from custom_directives import SupportedDevices, SupportedProperties

# Register custom directives

from docutils.parsers import rst

rst.directives.register_directive("devices", SupportedDevices)
rst.directives.register_directive("properties", SupportedProperties)