Repository navigation
Expand file tree
/
Copy pathconf.py
More file actions
78 lines (61 loc) · 2.29 KB
/
Copy pathconf.py
File metadata and controls
78 lines (61 loc) · 2.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
"""Configuration for sphinx."""
# 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
# -- 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
import sphinx_rtd_theme # noqa: F401
sys.path.insert(0, os.path.abspath("../"))
with open("../llama_index/VERSION") as f:
version = f.read()
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "LlamaIndex 🦙"
copyright = "2022, Jerry Liu"
author = "Jerry Liu"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.autodoc.typehints",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx_rtd_theme",
"sphinx.ext.mathjax",
"m2r2",
"myst_nb",
"sphinxcontrib.autodoc_pydantic",
]
myst_heading_anchors = 4
# TODO: Fix the non-consecutive header level in our docs, until then
# disable the sphinx/myst warnings
suppress_warnings = ["myst.header"]
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "furo"
html_title = project + " " + version
html_static_path = ["_static"]
html_css_files = [
"css/custom.css",
"css/algolia.css",
"https://cdn.jsdelivr.net/npm/@docsearch/css@3",
]
html_js_files = [
"js/mendablesearch.js",
(
"https://cdn.jsdelivr.net/npm/@docsearch/js@3.3.3/dist/umd/index.js",
{"defer": "defer"},
),
("js/algolia.js", {"defer": "defer"}),
]
nb_execution_mode = "off"
autodoc_pydantic_model_show_json_error_strategy = "coerce"