forked from Archives/langchain
101 lines
3.3 KiB
Python
101 lines
3.3 KiB
Python
"""Configuration file for the Sphinx documentation builder."""
|
|
# 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('.'))
|
|
|
|
import toml
|
|
|
|
with open("../pyproject.toml") as f:
|
|
data = toml.load(f)
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "🦜🔗 LangChain"
|
|
copyright = "2022, Harrison Chase"
|
|
author = "Harrison Chase"
|
|
|
|
version = data["tool"]["poetry"]["version"]
|
|
release = version
|
|
|
|
html_title = project + " " + version
|
|
|
|
|
|
# -- 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.autodoc.typehints",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.viewcode",
|
|
"sphinxcontrib.autodoc_pydantic",
|
|
"myst_nb",
|
|
"sphinx_panels",
|
|
"IPython.sphinxext.ipython_console_highlighting",
|
|
]
|
|
source_suffix = [".rst", ".md"]
|
|
|
|
|
|
autodoc_pydantic_model_show_json = False
|
|
autodoc_pydantic_field_list_validators = False
|
|
autodoc_pydantic_config_members = False
|
|
autodoc_pydantic_model_show_config_summary = False
|
|
autodoc_pydantic_model_show_validator_members = False
|
|
autodoc_pydantic_model_show_field_summary = False
|
|
autodoc_pydantic_model_members = False
|
|
autodoc_pydantic_model_undoc_members = False
|
|
# autodoc_typehints = "signature"
|
|
# autodoc_typehints = "description"
|
|
|
|
# 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_book_theme"
|
|
|
|
html_theme_options = {
|
|
"path_to_docs": "docs",
|
|
"repository_url": "https://github.com/hwchase17/langchain",
|
|
"use_repository_button": True,
|
|
}
|
|
|
|
html_context = {
|
|
"display_github": True, # Integrate GitHub
|
|
"github_user": "hwchase17", # Username
|
|
"github_repo": "langchain", # Repo name
|
|
"github_version": "master", # Version
|
|
"conf_py_path": "/docs/", # Path in the checkout to the docs root
|
|
}
|
|
|
|
# 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: list = []
|
|
nb_execution_mode = "off"
|
|
myst_enable_extensions = ["colon_fence"]
|