Repository navigation
Expand file tree
/
Copy pathconf.py
More file actions
123 lines (104 loc) · 5.78 KB
/
Copy pathconf.py
File metadata and controls
123 lines (104 loc) · 5.78 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
"""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 pkg_resources
import os
import sys
sys.path.insert(0, os.path.abspath("../"))
version = "v" + pkg_resources.get_distribution("llama-index-core").version
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "LlamaIndex 🦙"
copyright = "2023, 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",
"sphinx_reredirects",
"sphinx_automodapi.automodapi",
"sphinxcontrib.gtagjs",
]
# automodapi requires this to avoid duplicates apparently
numpydoc_show_class_members = False
myst_heading_anchors = 5
# 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", "DOCS_README.md"]
# -- 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"}),
("js/leadfeeder.js", {"defer": "defer"}),
]
html_permalinks_icon = "#"
nb_execution_mode = "off"
autodoc_pydantic_model_show_json_error_strategy = "coerce"
nitpicky = True
## Redirects
redirects = {
"end_to_end_tutorials/usage_pattern": "/en/stable/understanding/understanding.html",
"end_to_end_tutorials/one_click_observability": "/en/stable/module_guides/observability/observability.html",
"end_to_end_tutorials/dev_practices/production_rag": "/en/stable/optimizing/production_rag.html",
"end_to_end_tutorials/dev_practices/evaluation": "/en/stable/optimizing/evaluation/evaluation.html",
"end_to_end_tutorials/discover_llamaindex": "/en/stable/getting_started/discover_llamaindex.html",
"end_to_end_tutorials/finetuning": "/en/stable/optimizing/fine-tuning/fine-tuning.html",
"end_to_end_tutorials/low_level/root": "/en/stable/optimizing/building_rag_from_scratch.html",
"end_to_end_tutorials/use_cases": "/en/stable/use_cases/q_and_a/root.html",
"core_modules/data_modules/connector": "/en/stable/module_guides/loading/connector/root.html",
"core_modules/data_modules/documents_and_nodes/root": "/en/stable/module_guides/loading/documents_and_nodes/root.html",
"core_modules/data_modules/node_parsers/root": "/en/stable/module_guides/loading/node_parsers/root.html",
"core_modules/data_modules/storage/root": "/en/stable/module_guides/storing/storing.html",
"core_modules/data_modules/index/root": "/en/stable/module_guides/indexing/indexing.html",
"core_modules/query_modules/query_engine/root": "/en/stable/module_guides/deploying/query_engine/root.html",
"core_modules/query_modules/chat_engines/root": "/en/stable/module_guides/deploying/chat_engines/root.html",
"core_modules/query_modules/retriever/root": "/en/stable/module_guides/querying/retriever/root.html",
"core_modules/query_modules/router/root": "/en/stable/module_guides/querying/router/root.html",
"core_modules/query_modules/node_postprocessors/root": "/en/stable/module_guides/querying/node_postprocessors/root.html",
"core_modules/query_modules/response_synthesizers/root": "/en/stable/module_guides/querying/response_synthesizers/root.html",
"core_modules/query_modules/structured_outputs/root": "/en/stable/optimizing/advanced_retrieval/structured_outputs/structured_outputs.html",
"core_modules/agent_modules/agents/root": "/en/stable/module_guides/deploying/agents/root.html",
"core_modules/agent_modules/tools/root": "/en/stable/module_guides/deploying/agents/tools/root.html",
"core_modules/model_modules/llms/root": "/en/stable/module_guides/models/llms.html",
"core_modules/model_modules/embeddings/root": "/en/stable/module_guides/models/embeddings.html",
"core_modules/model_modules/prompts": "/en/stable/module_guides/models/prompts.html",
"core_modules/supporting_modules/service_context": "/en/stable/module_guides/supporting_modules/service_context.html",
"core_modules/supporting_modules/callbacks/root": "/en/stable/module_guides/observability/callbacks/root.html",
"core_modules/supporting_modules/evaluation/root": "/en/stable/module_guides/evaluating/root.html",
"core_modules/supporting_modules/cost_analysis/root": "/en/stable/understanding/evaluating/cost_analysis/root.html",
"api/llama_index.vector_stores.MongoDBAtlasVectorSearch": "/en/stable/examples/vector_stores/MongoDBAtlasVectorSearch.html",
}
gtagjs_ids = [
"G-BYVB1ZVE6J",
]