-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
145 lines (140 loc) · 3.97 KB
/
mkdocs.yml
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
site_name: GraphRAG
site_url: https://datastax.github.io/graph-rag
repo_url: https://github.com/datastax/graph-rag
edit_uri: edit/main/docs/
site_description:
extra_css:
- styles.css
extra:
analytics:
provider: google
property: "G-7DS0D7NZML"
plugins:
# Default social cards (see below to override)
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-social-cards/
- social
- search
- blog
- macros:
on_undefined: strict
- mkdocs-jupyter:
include_source: True
remove_tag_config:
remove_input_tags: ["hide_code"]
remove_cell_tags: ["hide_cell"]
remove_all_outputs_tags: ["hide_output"]
- mkdocstrings:
default_handler: python
handlers:
python:
inventories:
- https://python.langchain.com/api_reference/objects.inv
- https://networkx.org/documentation/stable/objects.inv
- https://numpy.org/doc/stable/objects.inv
- https://docs.python.org/3/objects.inv
options:
docstring_section_style: spacy
docstring_style: numpy
merge_init_into_class: true
show_symbol_type_toc: true
show_root_toc_entry: false
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
group_by_category: true
inherited_members: true
extensions:
- griffe_inherited_docstrings
- griffe_pydantic:
schema: true
filters: ["!^_[^_]"]
paths:
- packages/graph-retriever/src/
- packages/langchain-graph-retriever/src/
- packages/graph-rag-example-helpers/src/
markdown_extensions:
- admonition
- tables
- attr_list
- def_list
- toc:
title: On this page
permalink: true
- md_in_html
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
theme:
name: material
custom_dir: overrides
features:
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.tracking
- navigation.path
- toc.follow
- search.suggest
- search.highlight
- content.code.annotate
- content.code.copy
- content.tooltips
- content.tabs.link
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: teal
accent: teal
toggle:
icon: material/weather-sunny
name: Switch to light mode
nav:
- Home: index.md
- Guide:
- guide/index.md
- guide/get-started.md
- guide/traversal.md
- guide/edges.md
- guide/strategies.md
- guide/adapters.md
- guide/transformers.md
- Examples:
- examples/index.md
- examples/lazy-graph-rag.ipynb
- Reference:
- reference/index.md
- graph-retriever:
- reference/graph_retriever/index.md
- reference/graph_retriever/edges.md
- reference/graph_retriever/strategies.md
- reference/graph_retriever/adapters.md
- reference/graph_retriever/testing.md
- reference/graph_retriever/utils.md
- langchain-graph-retriever:
- reference/langchain_graph_retriever/index.md
- reference/langchain_graph_retriever/adapters.md
- reference/langchain_graph_retriever/transformers.md
- graph-rag-example-helpers:
- reference/graph_rag_example_helpers/index.md
- Blog:
- blog/index.md