2022-04-22 12:27:43 -07:00
|
|
|
#!/usr/bin/env python3
|
|
|
|
|
# Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
|
|
|
# All rights reserved.
|
|
|
|
|
#
|
|
|
|
|
# This source code is licensed under the BSD-style license found in the
|
|
|
|
|
# LICENSE file in the root directory of this source tree.
|
|
|
|
|
|
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
|
#
|
|
|
|
|
# This file only contains a selection of the most common options. For a full
|
|
|
|
|
# list see the documentation:
|
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
|
|
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
|
|
import pytorch_sphinx_theme
|
|
|
|
|
|
|
|
|
|
current_dir = os.path.dirname(__file__)
|
|
|
|
|
target_dir = os.path.abspath(os.path.join(current_dir, "../.."))
|
|
|
|
|
sys.path.insert(0, target_dir)
|
|
|
|
|
print(target_dir)
|
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
|
|
|
|
project = "PyTorchExamples"
|
|
|
|
|
copyright = "2022, Meta"
|
|
|
|
|
author = "Meta"
|
|
|
|
|
|
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
|
|
|
release = "1.11"
|
|
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
|
|
# ones.
|
2025-05-13 21:08:26 +02:00
|
|
|
extensions = ["sphinx.ext.napoleon", "sphinx.ext.autodoc", "sphinx_panels"]
|
2022-04-22 12:27:43 -07:00
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
|
|
templates_path = ["_templates"]
|
|
|
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
|
# directories to ignore when looking for source files.
|
|
|
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
|
|
|
exclude_patterns = []
|
|
|
|
|
|
|
|
|
|
# -- 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 = 'alabaster'
|
|
|
|
|
html_theme = "pytorch_sphinx_theme"
|
|
|
|
|
html_theme_path = [pytorch_sphinx_theme.get_html_theme_path()]
|
|
|
|
|
|
|
|
|
|
# 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"]
|
|
|
|
|
panels_add_fontawesome_latex = True
|
|
|
|
|
|
2022-04-25 11:16:03 -07:00
|
|
|
html_theme_options = {
|
|
|
|
|
'pytorch_project': 'examples',
|
|
|
|
|
'collapse_navigation': False,
|
|
|
|
|
'display_version': True,
|
|
|
|
|
'logo_only': False,
|
|
|
|
|
'analytics_id': 'UA-117752657-2',
|
|
|
|
|
}
|
