mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
9c364da9b9
Summary: Fixes https://github.com/pytorch/pytorch/issues/43669 The bool will still link to https://docs.python.org/3/library/functions.html#bool. Tested using bmm:  Pull Request resolved: https://github.com/pytorch/pytorch/pull/44686 Reviewed By: ngimel Differential Revision: D23703823 Pulled By: mruberry fbshipit-source-id: 7286afad084f5ab24a1254ad84e5d01907781c85
415 lines
13 KiB
Python
415 lines
13 KiB
Python
# -*- 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.
|
|
#
|
|
import os
|
|
# import sys
|
|
|
|
# source code directory, relative to this file, for sphinx-autobuild
|
|
# sys.path.insert(0, os.path.abspath('../..'))
|
|
|
|
import torch
|
|
|
|
try:
|
|
import torchvision # noqa: F401
|
|
except ImportError:
|
|
import warnings
|
|
warnings.warn('unable to load "torchvision" package')
|
|
|
|
RELEASE = os.environ.get('RELEASE', False)
|
|
|
|
import pytorch_sphinx_theme
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
#
|
|
needs_sphinx = '1.6'
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'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',
|
|
'sphinx.ext.autosectionlabel',
|
|
]
|
|
|
|
# build the templated autosummary files
|
|
autosummary_generate = True
|
|
numpydoc_show_class_members = False
|
|
|
|
# autosectionlabel throws warnings if section names are duplicated.
|
|
# The following tells autosectionlabel to not throw a warning for
|
|
# duplicated section names that are in different documents.
|
|
autosectionlabel_prefix_document = True
|
|
|
|
# katex options
|
|
#
|
|
#
|
|
|
|
katex_prerender = True
|
|
|
|
napoleon_use_ivar = True
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
if RELEASE:
|
|
templates_path = ['_templates-stable'] + templates_path
|
|
|
|
# TODO: document these and remove them from here.
|
|
|
|
coverage_ignore_modules = [
|
|
"torch.autograd",
|
|
"torch.cuda",
|
|
"torch.distributed",
|
|
"torch.distributions",
|
|
"torch.hub",
|
|
"torch.jit.unsupported_tensor_ops",
|
|
"torch.onnx",
|
|
"torch.nn.quantized.functional",
|
|
"torchvision",
|
|
]
|
|
|
|
coverage_ignore_functions = [
|
|
# torch.jit
|
|
"annotate",
|
|
"export_opnames",
|
|
"fuser",
|
|
"indent",
|
|
"interface",
|
|
"is_tracing",
|
|
"make_module",
|
|
"make_tuple",
|
|
"optimized_execution",
|
|
"script_method",
|
|
"validate_map_location",
|
|
"verify",
|
|
"whichmodule",
|
|
"wrap_check_inputs",
|
|
# torch
|
|
# TODO: This should be documented eventually, but only after
|
|
# we build out more support for meta functions and actually
|
|
# do a release with it
|
|
"empty_meta",
|
|
]
|
|
|
|
coverage_ignore_classes = [
|
|
# torch.jit
|
|
"Attribute",
|
|
"CompilationUnit",
|
|
"ConstMap",
|
|
"Error",
|
|
"Future",
|
|
"ONNXTracedModule",
|
|
"OrderedDictWrapper",
|
|
"OrderedModuleDict",
|
|
"RecursiveScriptModule",
|
|
"ScriptFunction",
|
|
"ScriptMeta",
|
|
"ScriptModule",
|
|
"ScriptWarning",
|
|
"TopLevelTracedModule",
|
|
"TracedModule",
|
|
"TracerWarning",
|
|
"TracingCheckError",
|
|
]
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
#
|
|
# source_suffix = ['.rst', '.md']
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = 'PyTorch'
|
|
copyright = '2019, Torch Contributors'
|
|
author = 'Torch Contributors'
|
|
|
|
# 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
|
|
version = 'master (' + torch.__version__ + ' )'
|
|
# The full version, including alpha/beta/rc tags.
|
|
# TODO: verify this works as expected
|
|
release = 'master'
|
|
|
|
# Customized html_title here.
|
|
# Default is " ".join(project, release, "documentation") if not set
|
|
if RELEASE:
|
|
# remove hash (start with 'a') from version number if any
|
|
version_end = torch.__version__.find('a')
|
|
if version_end == -1:
|
|
html_title = " ".join((project, torch.__version__, "documentation"))
|
|
else:
|
|
html_title = " ".join((project, torch.__version__[:version_end], "documentation"))
|
|
|
|
# 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.
|
|
pygments_style = 'sphinx'
|
|
|
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
todo_include_todos = True
|
|
|
|
# Disable docstring inheritance
|
|
autodoc_inherit_docstrings = False
|
|
|
|
|
|
# -- katex javascript in header
|
|
#
|
|
# def setup(app):
|
|
# app.add_javascript("https://cdn.jsdelivr.net/npm/katex@0.10.0-beta/dist/katex.min.js")
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
#
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
#
|
|
#
|
|
|
|
html_theme = 'pytorch_sphinx_theme'
|
|
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
|
|
|
|
# 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 = {
|
|
'pytorch_project': 'docs',
|
|
'canonical_url': 'https://pytorch.org/docs/stable/',
|
|
'collapse_navigation': False,
|
|
'display_version': True,
|
|
'logo_only': True,
|
|
}
|
|
|
|
html_logo = '_static/img/pytorch-logo-dark-unstable.png'
|
|
if RELEASE:
|
|
html_logo = '_static/img/pytorch-logo-dark.svg'
|
|
|
|
|
|
# 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".
|
|
html_static_path = ['_static']
|
|
|
|
html_css_files = [
|
|
'css/jit.css',
|
|
]
|
|
|
|
|
|
# Called automatically by Sphinx, making this `conf.py` an "extension".
|
|
def setup(app):
|
|
# NOTE: in Sphinx 1.8+ `html_css_files` is an official configuration value
|
|
# and can be moved outside of this function (and the setup(app) function
|
|
# can be deleted).
|
|
html_css_files = [
|
|
'https://cdn.jsdelivr.net/npm/katex@0.10.0-beta/dist/katex.min.css'
|
|
]
|
|
|
|
# In Sphinx 1.8 it was renamed to `add_css_file`, 1.7 and prior it is
|
|
# `add_stylesheet` (deprecated in 1.8).
|
|
add_css = getattr(app, 'add_css_file', app.add_stylesheet)
|
|
for css_file in html_css_files:
|
|
add_css(css_file)
|
|
|
|
# From PyTorch 1.5, we now use autogenerated files to document classes and
|
|
# functions. This breaks older references since
|
|
# https://docs.pytorch.org/torch.html#torch.flip
|
|
# moved to
|
|
# https://docs.pytorch.org/torch/generated/torchflip.html
|
|
# which breaks older links from blog posts, stack overflow answers and more.
|
|
# To mitigate that, we add an id="torch.flip" in an appropriated place
|
|
# in torch.html by overriding the visit_reference method of html writers.
|
|
# Someday this can be removed, once the old links fade away
|
|
|
|
from sphinx.writers import html, html5
|
|
|
|
def replace(Klass):
|
|
old_call = Klass.visit_reference
|
|
|
|
def visit_reference(self, node):
|
|
if 'refuri' in node and 'generated' in node.get('refuri'):
|
|
ref = node.get('refuri')
|
|
ref_anchor = ref.split('#')
|
|
if len(ref_anchor) > 1:
|
|
# Only add the id if the node href and the text match,
|
|
# i.e. the href is "torch.flip#torch.flip" and the content is
|
|
# "torch.flip" or "flip" since that is a signal the node refers
|
|
# to autogenerated content
|
|
anchor = ref_anchor[1]
|
|
txt = node.parent.astext()
|
|
if txt == anchor or txt == anchor.split('.')[-1]:
|
|
self.body.append('<p id="{}"/>'.format(ref_anchor[1]))
|
|
return old_call(self, node)
|
|
Klass.visit_reference = visit_reference
|
|
|
|
replace(html.HTMLTranslator)
|
|
replace(html5.HTML5Translator)
|
|
|
|
# -- Options for HTMLHelp output ------------------------------------------
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'PyTorchdoc'
|
|
|
|
|
|
# -- 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 = [
|
|
(master_doc, 'pytorch.tex', 'PyTorch Documentation',
|
|
'Torch Contributors', 'manual'),
|
|
]
|
|
|
|
|
|
# -- Options for manual page output ---------------------------------------
|
|
|
|
# One entry per manual page. List of tuples
|
|
# (source start file, name, description, authors, manual section).
|
|
man_pages = [
|
|
(master_doc, 'PyTorch', 'PyTorch Documentation',
|
|
[author], 1)
|
|
]
|
|
|
|
|
|
# -- 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 = [
|
|
(master_doc, 'PyTorch', 'PyTorch Documentation',
|
|
author, 'PyTorch', 'One line description of project.',
|
|
'Miscellaneous'),
|
|
]
|
|
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
intersphinx_mapping = {
|
|
'python': ('https://docs.python.org/3', None),
|
|
'numpy': ('https://numpy.org/doc/stable', None),
|
|
}
|
|
|
|
# -- A patch that prevents Sphinx from cross-referencing ivar tags -------
|
|
# See http://stackoverflow.com/a/41184353/3343043
|
|
|
|
from docutils import nodes
|
|
from sphinx.util.docfields import TypedField
|
|
from sphinx import addnodes
|
|
import sphinx.ext.doctest
|
|
|
|
# Without this, doctest adds any example with a `>>>` as a test
|
|
doctest_test_doctest_blocks = ''
|
|
doctest_default_flags = sphinx.ext.doctest.doctest.ELLIPSIS
|
|
doctest_global_setup = '''
|
|
try:
|
|
import torchvision
|
|
except ImportError:
|
|
torchvision = None
|
|
'''
|
|
|
|
|
|
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!
|
|
|
|
# type: (List, unicode, Tuple) -> nodes.field
|
|
def handle_item(fieldarg, content):
|
|
par = nodes.paragraph()
|
|
par += addnodes.literal_strong('', fieldarg) # Patch: this line added
|
|
# par.extend(self.make_xrefs(self.rolename, domain, fieldarg,
|
|
# addnodes.literal_strong))
|
|
if fieldarg in types:
|
|
par += nodes.Text(' (')
|
|
# 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):
|
|
typename = u''.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('bool', 'python:bool')
|
|
typename = typename.replace('type', 'python:type')
|
|
par.extend(self.make_xrefs(self.typerolename, domain, typename,
|
|
addnodes.literal_emphasis, **kw))
|
|
else:
|
|
par += fieldtype
|
|
par += nodes.Text(')')
|
|
par += nodes.Text(' -- ')
|
|
par += content
|
|
return par
|
|
|
|
fieldname = nodes.field_name('', self.label)
|
|
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:
|
|
bodynode += nodes.list_item('', handle_item(fieldarg, content))
|
|
fieldbody = nodes.field_body('', bodynode)
|
|
return nodes.field('', fieldname, fieldbody)
|
|
|
|
TypedField.make_field = patched_make_field
|