mirror of
https://github.com/NVIDIA/TensorRT-LLM.git
synced 2026-01-14 06:27:45 +08:00
159 lines
4.6 KiB
Python
159 lines
4.6 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
|
|
|
|
import importlib.util
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
|
|
import pygit2
|
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
project = 'TensorRT-LLM'
|
|
copyright = '2025, NVidia'
|
|
author = 'NVidia'
|
|
branch_name = pygit2.Repository('.').head.shorthand
|
|
html_show_sphinx = False
|
|
|
|
# Get the version from the version.py file
|
|
version_path = os.path.abspath(
|
|
os.path.join(os.path.dirname(__file__), "../../tensorrt_llm/version.py"))
|
|
spec = importlib.util.spec_from_file_location("version_module", version_path)
|
|
version_module = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(version_module)
|
|
version = version_module.__version__
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = ['performance/performance-tuning-guide/introduction.md']
|
|
|
|
extensions = [
|
|
'sphinx.ext.duration',
|
|
'sphinx.ext.autodoc',
|
|
'sphinx.ext.autosummary',
|
|
'sphinx.ext.viewcode',
|
|
'sphinx.ext.napoleon',
|
|
'myst_parser', # for markdown support
|
|
"breathe",
|
|
'sphinx.ext.todo',
|
|
'sphinx.ext.autosectionlabel',
|
|
'sphinxarg.ext',
|
|
'sphinx_click',
|
|
'sphinx_copybutton',
|
|
'sphinxcontrib.autodoc_pydantic'
|
|
]
|
|
|
|
autodoc_pydantic_model_show_json = True
|
|
autodoc_pydantic_model_show_config_summary = True
|
|
autodoc_pydantic_field_doc_policy = "description"
|
|
autodoc_pydantic_model_show_field_list = True # Display field list with descriptions
|
|
|
|
myst_url_schemes = {
|
|
"http":
|
|
None,
|
|
"https":
|
|
None,
|
|
"source":
|
|
"https://github.com/NVIDIA/TensorRT-LLM/tree/" + branch_name + "/{{path}}",
|
|
}
|
|
|
|
myst_heading_anchors = 4
|
|
|
|
myst_enable_extensions = [
|
|
"deflist",
|
|
]
|
|
|
|
autosummary_generate = True
|
|
copybutton_exclude = '.linenos, .gp, .go'
|
|
copybutton_prompt_text = ">>> |$ |# "
|
|
copybutton_line_continuation_character = "\\"
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
source_suffix = {
|
|
'.rst': 'restructuredtext',
|
|
'.txt': 'markdown',
|
|
'.md': 'markdown',
|
|
}
|
|
|
|
html_theme = 'nvidia_sphinx_theme'
|
|
html_static_path = ['_static']
|
|
html_extra_path = ["./_static/switcher.json"]
|
|
html_theme_options = {
|
|
"switcher": {
|
|
"json_url": "./_static/switcher.json",
|
|
"version_match": version,
|
|
"check_switcher": True,
|
|
},
|
|
}
|
|
|
|
# ------------------------ C++ Doc related --------------------------
|
|
# Breathe configuration
|
|
breathe_default_project = "TensorRT-LLM"
|
|
breathe_projects = {"TensorRT-LLM": "../cpp_docs/xml"}
|
|
|
|
SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
|
|
|
|
CPP_INCLUDE_DIR = os.path.join(SCRIPT_DIR, '../../cpp/include/tensorrt_llm')
|
|
CPP_GEN_DIR = os.path.join(SCRIPT_DIR, '_cpp_gen')
|
|
print('CPP_INCLUDE_DIR', CPP_INCLUDE_DIR)
|
|
print('CPP_GEN_DIR', CPP_GEN_DIR)
|
|
|
|
|
|
def setup(app):
|
|
from helper import generate_examples, generate_llmapi
|
|
|
|
generate_examples()
|
|
generate_llmapi()
|
|
|
|
|
|
def gen_cpp_doc(ofile_name: str, header_dir: str, summary: str):
|
|
cpp_header_files = [
|
|
file for file in os.listdir(header_dir) if file.endswith('.h')
|
|
]
|
|
|
|
with open(ofile_name, 'w') as ofile:
|
|
ofile.write(summary + "\n")
|
|
for header in cpp_header_files:
|
|
ofile.write(f"{header}\n")
|
|
ofile.write("_" * len(header) + "\n\n")
|
|
|
|
ofile.write(f".. doxygenfile:: {header}\n")
|
|
ofile.write(" :project: TensorRT-LLM\n\n")
|
|
|
|
|
|
runtime_summary = f"""
|
|
Runtime
|
|
==========
|
|
|
|
.. Here are files in the cpp/include/runtime
|
|
.. We manually add subsection to enable detailed description in the future
|
|
.. It is also doable to automatically generate this file and list all the modules in the conf.py
|
|
""".strip()
|
|
|
|
# compile cpp doc
|
|
subprocess.run(['mkdir', '-p', CPP_GEN_DIR])
|
|
gen_cpp_doc(CPP_GEN_DIR + '/runtime.rst', CPP_INCLUDE_DIR + '/runtime',
|
|
runtime_summary)
|
|
|
|
executor_summary = f"""
|
|
Executor
|
|
==========
|
|
|
|
.. Here are files in the cpp/include/executor
|
|
.. We manually add subsection to enable detailed description in the future
|
|
.. It is also doable to automatically generate this file and list all the modules in the conf.py
|
|
""".strip()
|
|
|
|
subprocess.run(['mkdir', '-p', CPP_GEN_DIR])
|
|
gen_cpp_doc(CPP_GEN_DIR + '/executor.rst', CPP_INCLUDE_DIR + '/executor',
|
|
executor_summary)
|