mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-08-28 05:25:04 +00:00
105 lines
3.1 KiB
Python
105 lines
3.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# 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, like shown here.
|
|
#
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath("../../../../../MemoryScope"))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
language = "zh"
|
|
|
|
project = "MemoryScope"
|
|
copyright = "2024, Alibaba Tongyi Lab"
|
|
author = "EcoML team of Alibaba Tongyi Lab"
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.napoleon",
|
|
"sphinxcontrib.mermaid",
|
|
"myst_parser",
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinxcontrib.autodoc_pydantic",
|
|
"nbsphinx"
|
|
]
|
|
|
|
autodoc_pydantic_model_show_json = True
|
|
autodoc_pydantic_settings_show_json = True
|
|
|
|
# Prefix document path to section labels, otherwise autogenerated labels would
|
|
# look like 'heading' rather than 'path/to/file:heading'
|
|
autosectionlabel_prefix_document = True
|
|
autosummary_generate = True
|
|
autosummary_ignore_module_all = False
|
|
|
|
autodoc_member_order = "bysource"
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
add_function_parentheses = False
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = True
|
|
|
|
autodoc_default_flags = ["members"]
|
|
|
|
autodoc_default_options = {
|
|
"members": True,
|
|
"member-order": "bysource",
|
|
"special-members": "__init__",
|
|
}
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
# html_logo = "_static/logo.png"
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ["_static"]
|
|
|
|
html_theme_options = {
|
|
# "logo_only": True,
|
|
"navigation_depth": 4,
|
|
}
|
|
|
|
source_suffix = {
|
|
".rst": "restructuredtext",
|
|
".md": "markdown",
|
|
}
|
|
|
|
html_css_files = [
|
|
"custom.css",
|
|
]
|