mirror of
https://github.com/hanzoai/anomalib.git
synced 2026-10-30 18:48:11 +00:00
zeekay
dda5b2a367
The previous commit was meant to remove .github/workflows and removed every tracked path instead — 892 files, the whole repo. This puts back the 874 that were never in scope; the eighteen workflow files stay gone, for the reasons that commit gives. Content is byte-identical to 9d2aec9 outside .github/workflows.
108 lines
2.9 KiB
Python
108 lines
2.9 KiB
Python
"""Configuration file for the Sphinx documentation builder.
|
|
|
|
For the full list of built-in configuration values, see the documentation:
|
|
https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
-- Project information -----------------------------------------------------
|
|
https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
"""
|
|
|
|
# Copyright (C) 2022-2025 Intel Corporation
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
# Define paths
|
|
project_root = Path(__file__).parent.parent.parent
|
|
module_path = project_root / "src"
|
|
examples_path = project_root / "examples"
|
|
|
|
# Insert paths to sys.path
|
|
sys.path.insert(0, str(module_path.resolve()))
|
|
sys.path.insert(0, str(project_root.resolve()))
|
|
|
|
project = "Anomalib"
|
|
copyright = "Intel Corporation" # noqa: A001
|
|
author = "Intel Corporation"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.mathjax",
|
|
"sphinx_design",
|
|
"myst_parser",
|
|
"nbsphinx",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx_autodoc_typehints",
|
|
"sphinx_copybutton",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.autosectionlabel",
|
|
]
|
|
|
|
# MyST configuration
|
|
myst_enable_extensions = [
|
|
"colon_fence",
|
|
"linkify",
|
|
"substitution",
|
|
"tasklist",
|
|
"deflist",
|
|
"fieldlist",
|
|
"amsmath",
|
|
"dollarmath",
|
|
]
|
|
|
|
# Add separate setting for eval-rst
|
|
myst_enable_eval_rst = True
|
|
|
|
# Notebook handling
|
|
nbsphinx_allow_errors = True
|
|
nbsphinx_execute = "auto" # Execute notebooks during build
|
|
nbsphinx_timeout = 300 # Timeout in seconds
|
|
|
|
# Templates and patterns
|
|
templates_path = ["_templates"]
|
|
exclude_patterns: list[str] = [
|
|
"_build",
|
|
"**.ipynb_checkpoints",
|
|
"**/.pytest_cache",
|
|
"**/.git",
|
|
"**/.github",
|
|
"**/.venv",
|
|
"**/*.egg-info",
|
|
"**/build",
|
|
"**/dist",
|
|
]
|
|
|
|
# Automatic exclusion of prompts from the copies
|
|
# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies
|
|
copybutton_exclude = ".linenos, .gp, .go"
|
|
|
|
# Enable section anchors for cross-referencing
|
|
autosectionlabel_prefix_document = True
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = "sphinx_book_theme"
|
|
html_logo = "_static/images/logos/anomalib-icon.png"
|
|
html_favicon = "_static/images/logos/anomalib-favicon.png"
|
|
html_static_path = ["_static"]
|
|
html_theme_options = {
|
|
"logo": {
|
|
"text": "Anomalib",
|
|
},
|
|
}
|
|
|
|
# Add references to example files
|
|
html_context = {"examples_path": str(examples_path)}
|
|
|
|
# External documentation references
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
"torch": ("https://pytorch.org/docs/stable", None),
|
|
"lightning": ("https://lightning.ai/docs/pytorch/stable/", None),
|
|
}
|