82 lines
2.4 KiB
Python
82 lines
2.4 KiB
Python
# SPDX-FileCopyrightText: Copyright (c) 2023-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
import os
|
|
import sys
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
project = "NVIDIA Dynamo"
|
|
copyright = "2024-2025, NVIDIA CORPORATION & AFFILIATES"
|
|
author = "NVIDIA"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Standard extensions
|
|
extensions = [
|
|
"ablog",
|
|
"myst_parser",
|
|
"sphinx_copybutton",
|
|
"sphinx_design",
|
|
"sphinx_prompt",
|
|
# "sphinxcontrib.bibtex",
|
|
"sphinx_tabs.tabs",
|
|
"sphinx_sitemap",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.mathjax",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.ifconfig",
|
|
"sphinx.ext.extlinks",
|
|
"sphinxcontrib.mermaid",
|
|
]
|
|
|
|
# Custom extensions
|
|
sys.path.insert(0, os.path.abspath("_extensions"))
|
|
extensions.append("github_alerts")
|
|
|
|
# Handle Mermaid diagrams as code blocks (not directives) to avoid warnings
|
|
myst_fence_as_directive = ["mermaid"] # Uncomment if sphinxcontrib-mermaid is installed
|
|
|
|
# File extensions (myst_parser automatically handles .md files)
|
|
source_suffix = [".rst", ".md"]
|
|
|
|
# MyST parser configuration
|
|
myst_enable_extensions = [
|
|
"colon_fence", # ::: code blocks
|
|
"deflist", # Definition lists
|
|
"html_image", # HTML images
|
|
"tasklist", # Task lists
|
|
]
|
|
|
|
# Templates path
|
|
templates_path = ["_templates"]
|
|
|
|
# List of patterns to ignore when looking for source files
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "build"]
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
html_theme = "nvidia_sphinx_theme"
|
|
html_static_path = ["_static"]
|
|
html_theme_options = {
|
|
"collapse_navigation": False,
|
|
"github_url": "https://github.com/ai-dynamo/dynamo",
|
|
"navbar_start": ["navbar-logo"],
|
|
"primary_sidebar_end": [],
|
|
}
|
|
|
|
# Document settings
|
|
master_doc = "index"
|
|
html_title = f"{project} Documentation"
|
|
html_short_title = project
|
|
html_baseurl = "https://docs.nvidia.com/dynamo/latest/"
|
|
|
|
# Suppress warnings for external links and missing references
|
|
suppress_warnings = [
|
|
"myst.xref_missing", # Missing cross-references of relative links outside docs folder
|
|
]
|
|
|
|
# Additional MyST configuration
|
|
myst_heading_anchors = 7 # Generate anchors for headers
|
|
myst_substitutions = {} # Custom substitutions
|