Files
nunchaku-tech-ComfyUI-nunchaku/docs/source/conf.py
T
82dfce256f feat: new tests for nunchaku comfyui from lmxyy & ttio2tech, tested and verified on comfyui 0.3.63 upstream and 0.3.60 LTS (#641) (#650)
* bump requires-python

* model patcher now implements everything it needs for comfyui

* index

* Support LTS and Vanilla ComfyUI

* Fix version string when installed as package (not material)

* style: make linter happy

* update init.py

* Update nunchaku index

* Bump dependencies, include config and workflows when installed using pip/uv

* Update installation instructions to include ComfyUI LTS

* Update requirements for nunchaku>=1.0.1

* Fix torch210 key

* Fix pep 508 spec

* Improve tests (still more to go)

* Fix comfyui_controlnet_aux flaws

* Update tests (all should pass)

* Organize the tests in this runner

* Update contribution guide

* Install uv

* Dependencies now resolve with correct conflicts with uv's most stringent resolution

* Mediapipe hasn't been built for 3.13 yet, so we can't use it here

* Remove controlnet-aux dep

* make linter happy

* make the linter happy

* optimize the loading

* update installation

* update

* update contribution guide

* update qwenimage

* need to figure out why the toml parsing doesn't owk

* update

* update

* update

* style: make linter happy

* update

* add pulid requirement

* update docs

* update

* update

* update

* update

* update

* organize the pyproject.toml

* update

* update

* update

* passing all tests

* update

* update

* update

* update

* update

* remove a useless class

* update

* update

* fix a typo

---------

Co-authored-by: doctorpangloss <@hiddenswitch.com>
Co-authored-by: doctorpangloss <2229300+doctorpangloss@users.noreply.github.com>
2025-10-14 00:46:20 -04:00

93 lines
2.8 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
import re
import sys
import tomllib
from pathlib import Path
sys.path.insert(0, str(Path(__file__).parent.parent.parent.parent))
project = "ComfyUI-nunchaku"
copyright = "2025, Nunchaku Team"
author = "Nunchaku Team"
cur_path = Path(__file__)
toml_path = cur_path.parent.parent.parent / "pyproject.toml"
with open(toml_path, "rb") as f:
data = tomllib.load(f)
version = data["project"]["version"]
if "dev" in version:
version = re.sub(r"dev\d*", "", version)
release = version
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
"sphinx_tabs.tabs",
"sphinx.ext.extlinks",
"myst_parser",
"sphinx_copybutton",
"sphinxcontrib.mermaid",
"nbsphinx",
"sphinx.ext.mathjax",
"breathe",
]
templates_path = ["_templates"]
exclude_patterns = []
# -- Include global link definitions -----------------------------------------
links_dir = Path(__file__).parent / "links"
rst_epilog = ""
if links_dir.exists() and links_dir.is_dir():
for link_file in sorted(links_dir.glob("*.txt")):
with open(link_file, encoding="utf-8") as f:
rst_epilog += f.read()
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "sphinx_book_theme"
html_static_path = ["_static"]
napoleon_google_docstring = False
napoleon_numpy_docstring = True
extlinks = {
"nunchaku-issue": ("https://github.com/mit-han-lab/nunchaku/issues/%s", "nunchaku#%s"),
"comfyui-issue": ("https://github.com/mit-han-lab/ComfyUI-nunchaku/issues/%s", "ComfyUI-nunchaku#%s"),
}
intersphinx_mapping = {
"nunchaku": ("https://nunchaku.tech/docs/nunchaku", None),
}
html_theme_options = {
"repository_url": "https://github.com/nunchaku-tech/ComfyUI-nunchaku",
"repository_branch": "main",
"path_to_docs": "docs/source",
"use_repository_button": True,
"use_edit_page_button": True,
"use_issues_button": True,
"use_download_button": True,
"show_navbar_depth": 2,
"show_toc_level": 2,
# "announcement": "🔥 Nunchaku v1.2 released!",
}
html_favicon = "_static/nunchaku.ico"