76 lines
2.1 KiB
Python
76 lines
2.1 KiB
Python
# 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.
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath("../.."))
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "TexTeller"
|
|
copyright = "2025, TexTeller Team"
|
|
author = "TexTeller Team"
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
"myst_parser",
|
|
"sphinx.ext.duration",
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx_copybutton",
|
|
# 'sphinx.ext.linkcode',
|
|
# 'sphinxarg.ext',
|
|
"sphinx_design",
|
|
"nbsphinx",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = []
|
|
|
|
# Autodoc settings
|
|
autodoc_member_order = "bysource"
|
|
add_module_names = False
|
|
autoclass_content = "both"
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"member-order": "bysource",
|
|
"undoc-members": True,
|
|
"show-inheritance": True,
|
|
"imported-members": True,
|
|
}
|
|
|
|
# Intersphinx settings
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
"numpy": ("https://numpy.org/doc/stable", None),
|
|
"torch": ("https://pytorch.org/docs/stable", None),
|
|
"transformers": ("https://huggingface.co/docs/transformers/main/en", None),
|
|
}
|
|
|
|
html_theme = "sphinx_book_theme"
|
|
|
|
html_theme_options = {
|
|
"repository_url": "https://github.com/OleehyO/TexTeller",
|
|
"use_repository_button": True,
|
|
"use_issues_button": True,
|
|
"use_edit_page_button": True,
|
|
"use_download_button": True,
|
|
}
|
|
|
|
html_logo = "../../assets/logo.svg"
|