mirror of
https://github.com/microsoft/autogen.git
synced 2025-07-14 12:31:28 +00:00
49 lines
1.4 KiB
Python
49 lines
1.4 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
|
||
|
|
|
||
|
|
project = "agnext"
|
||
|
|
copyright = "2024, Microsoft"
|
||
|
|
author = "Microsoft"
|
||
|
|
|
||
|
|
# -- General configuration ---------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||
|
|
|
||
|
|
extensions = [
|
||
|
|
"sphinx.ext.autodoc",
|
||
|
|
"sphinx.ext.autosummary",
|
||
|
|
"sphinx.ext.napoleon",
|
||
|
|
"sphinxcontrib.apidoc"
|
||
|
|
]
|
||
|
|
|
||
|
|
apidoc_module_dir = '../../src/agnext'
|
||
|
|
apidoc_output_dir = 'reference'
|
||
|
|
apidoc_template_dir = '_apidoc_templates'
|
||
|
|
apidoc_separate_modules = True
|
||
|
|
apidoc_extra_args = ["--no-toc"]
|
||
|
|
|
||
|
|
templates_path = []
|
||
|
|
exclude_patterns = ["reference/agnext.rst"]
|
||
|
|
|
||
|
|
autoclass_content = "init"
|
||
|
|
|
||
|
|
# Guides and tutorials must succeed.
|
||
|
|
nb_execution_raise_on_error = True
|
||
|
|
nb_execution_timeout = 60
|
||
|
|
|
||
|
|
# -- Options for HTML output -------------------------------------------------
|
||
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||
|
|
|
||
|
|
html_theme = "furo"
|
||
|
|
html_static_path = []
|
||
|
|
|
||
|
|
html_theme_options = {
|
||
|
|
"source_repository": "https://github.com/microsoft/agnext",
|
||
|
|
"source_branch": "main",
|
||
|
|
"source_directory": "docs/src/",
|
||
|
|
}
|