mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 21:14:14 +08:00
Enable UFMT on a bunch of low traffic Python files outside of main files (#106052)
Signed-off-by: Edward Z. Yang <ezyang@meta.com> Pull Request resolved: https://github.com/pytorch/pytorch/pull/106052 Approved by: https://github.com/albanD, https://github.com/Skylion007
This commit is contained in:
Edward Z. Yang
committed by
PyTorch MergeBot
PyTorch MergeBot
parent
5a114f72bf
commit
f70844bec7
@ -19,6 +19,7 @@
|
||||
# enabled on nightlies (and not trunk or on PRs) due to OOM errors in CI.
|
||||
# See https://github.com/pytorch/pytorch/issues/79992.
|
||||
import os
|
||||
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
import textwrap
|
||||
@ -27,22 +28,17 @@ import textwrap
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
needs_sphinx = '3.1.2'
|
||||
run_doxygen = os.environ.get('RUN_DOXYGEN', "false") == "true"
|
||||
needs_sphinx = "3.1.2"
|
||||
run_doxygen = os.environ.get("RUN_DOXYGEN", "false") == "true"
|
||||
|
||||
# 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.intersphinx',
|
||||
] + ([
|
||||
'breathe',
|
||||
'exhale'
|
||||
] if run_doxygen else [])
|
||||
"sphinx.ext.intersphinx",
|
||||
] + (["breathe", "exhale"] if run_doxygen else [])
|
||||
|
||||
intersphinx_mapping = {
|
||||
'pytorch': ('https://pytorch.org/docs/main', None)
|
||||
}
|
||||
intersphinx_mapping = {"pytorch": ("https://pytorch.org/docs/main", None)}
|
||||
|
||||
# Setup absolute paths for communicating with breathe / exhale where
|
||||
# items are expected / should be trimmed by.
|
||||
@ -50,13 +46,13 @@ intersphinx_mapping = {
|
||||
this_file_dir = os.path.abspath(os.path.dirname(__file__))
|
||||
doxygen_xml_dir = os.path.join(
|
||||
os.path.dirname(this_file_dir), # {repo_root}/docs/cpp
|
||||
'build', # {repo_root}/docs/cpp/build
|
||||
'xml' # {repo_root}/docs/cpp/build/xml
|
||||
"build", # {repo_root}/docs/cpp/build
|
||||
"xml", # {repo_root}/docs/cpp/build/xml
|
||||
)
|
||||
repo_root = os.path.dirname( # {repo_root}
|
||||
os.path.dirname( # {repo_root}/docs
|
||||
os.path.dirname( # {repo_root}/docs/cpp
|
||||
this_file_dir # {repo_root}/docs/cpp/source
|
||||
os.path.dirname( # {repo_root}/docs
|
||||
os.path.dirname( # {repo_root}/docs/cpp
|
||||
this_file_dir # {repo_root}/docs/cpp/source
|
||||
)
|
||||
)
|
||||
)
|
||||
@ -98,16 +94,18 @@ exhale_args = {
|
||||
############################################################################
|
||||
# Main library page layout example configuration. #
|
||||
############################################################################
|
||||
"afterTitleDescription": textwrap.dedent('''
|
||||
"afterTitleDescription": textwrap.dedent(
|
||||
"""
|
||||
Welcome to the developer reference for the PyTorch C++ API.
|
||||
'''),
|
||||
"""
|
||||
),
|
||||
}
|
||||
|
||||
# Tell sphinx what the primary language being documented is.
|
||||
primary_domain = 'cpp'
|
||||
primary_domain = "cpp"
|
||||
|
||||
# Tell sphinx what the pygments highlight language should be.
|
||||
highlight_language = 'cpp'
|
||||
highlight_language = "cpp"
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
# templates_path = ['_templates']
|
||||
@ -116,15 +114,15 @@ highlight_language = 'cpp'
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
source_suffix = ".rst"
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
master_doc = "index"
|
||||
|
||||
# General information about the project.
|
||||
project = 'PyTorch'
|
||||
copyright = '2022, PyTorch Contributors'
|
||||
author = 'PyTorch Contributors'
|
||||
project = "PyTorch"
|
||||
copyright = "2022, PyTorch Contributors"
|
||||
author = "PyTorch 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
|
||||
@ -132,10 +130,10 @@ author = 'PyTorch Contributors'
|
||||
#
|
||||
# The short X.Y version.
|
||||
# TODO: change to [:2] at v1.0
|
||||
version = 'main'
|
||||
version = "main"
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
# TODO: verify this works as expected
|
||||
release = 'main'
|
||||
release = "main"
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
@ -150,7 +148,7 @@ language = None
|
||||
exclude_patterns = []
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = "sphinx"
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
@ -160,30 +158,30 @@ todo_include_todos = True
|
||||
# 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 = "pytorch_sphinx_theme"
|
||||
|
||||
# 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 = {
|
||||
'canonical_url': 'https://pytorch.org/docs/stable/',
|
||||
'pytorch_project': 'docs',
|
||||
'collapse_navigation': False,
|
||||
'display_version': True,
|
||||
'logo_only': True,
|
||||
"canonical_url": "https://pytorch.org/docs/stable/",
|
||||
"pytorch_project": "docs",
|
||||
"collapse_navigation": False,
|
||||
"display_version": True,
|
||||
"logo_only": True,
|
||||
}
|
||||
|
||||
# NOTE: sharing python docs resources
|
||||
html_logo = os.path.join(
|
||||
repo_root, 'docs', 'source', '_static', 'img', 'pytorch-logo-dark-unstable.png'
|
||||
repo_root, "docs", "source", "_static", "img", "pytorch-logo-dark-unstable.png"
|
||||
)
|
||||
|
||||
# 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".
|
||||
# NOTE: sharing python docs resources
|
||||
html_static_path = [os.path.join(repo_root, 'docs', 'cpp', 'source', '_static')]
|
||||
html_static_path = [os.path.join(repo_root, "docs", "cpp", "source", "_static")]
|
||||
|
||||
|
||||
# Called automatically by Sphinx, making this `conf.py` an "extension".
|
||||
@ -191,14 +189,15 @@ 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 = ['cpp_theme.css']
|
||||
html_css_files = ["cpp_theme.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)
|
||||
add_css = getattr(app, "add_css_file", app.add_stylesheet)
|
||||
for css_file in html_css_files:
|
||||
add_css(css_file)
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
@ -211,15 +210,12 @@ 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',
|
||||
@ -229,8 +225,13 @@ latex_elements = {
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'pytorch.tex', 'PyTorch Documentation',
|
||||
'Torch Contributors', 'manual'),
|
||||
(
|
||||
master_doc,
|
||||
"pytorch.tex",
|
||||
"PyTorch Documentation",
|
||||
"Torch Contributors",
|
||||
"manual",
|
||||
),
|
||||
]
|
||||
|
||||
|
||||
@ -238,10 +239,7 @@ latex_documents = [
|
||||
|
||||
# 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)
|
||||
]
|
||||
man_pages = [(master_doc, "PyTorch", "PyTorch Documentation", [author], 1)]
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
@ -250,7 +248,13 @@ man_pages = [
|
||||
# (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'),
|
||||
(
|
||||
master_doc,
|
||||
"PyTorch",
|
||||
"PyTorch Documentation",
|
||||
author,
|
||||
"PyTorch",
|
||||
"One line description of project.",
|
||||
"Miscellaneous",
|
||||
),
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user