-
-
Notifications
You must be signed in to change notification settings - Fork 14
/
mkdocs.yml
175 lines (169 loc) · 4.88 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
site_name: bigtree Documentation
site_url: https://kayjan.github.io/bigtree
repo_url: https://github.com/kayjan/bigtree
repo_name: bigtree
nav:
- Home:
- index.md
- home.md
- home/install.md
- Components:
- home/tree.md
- home/binarytree.md
- home/dag.md
- Community:
- home/community.md
- home/contributing.md
- home/convention.md
- Changes:
- home/benchmarks.md
- home/changelog.md
- Getting Started:
- Demonstration:
- gettingstarted/demo/tree.md
- gettingstarted/demo/binarytree.md
- gettingstarted/demo/dag.md
- gettingstarted/demo/Workflow Demonstration.ipynb
- Resources:
- gettingstarted/resources/articles.md
- gettingstarted/resources/glossary.md
- Playground:
- playground/index.md
- Code Documentation:
- 🌿 Node:
- bigtree/node/basenode.md
- bigtree/node/node.md
- bigtree/node/binarynode.md
- bigtree/node/dagnode.md
- 🌵 Binary Tree:
- bigtree/binarytree/construct.md
- 🌴 DAG:
- bigtree/dag/construct.md
- bigtree/dag/export.md
- 🌲 Tree:
- bigtree/tree/construct.md
- bigtree/tree/export.md
- bigtree/tree/helper.md
- bigtree/tree/modify.md
- bigtree/tree/search.md
- 🔧 Utils:
- bigtree/utils/iterators.md
- bigtree/utils/plot.md
- 👷 Workflows:
- bigtree/workflows/app_todo.md
- bigtree/workflows/app_calendar.md
- Others:
- 💡 Tips and Tricks:
- others/remove_checks.md
- others/list_dir.md
- others/nodes.md
- others/merging_trees.md
- others/weighted_trees.md
- others/work_with_classes.md
theme:
name: material
custom_dir: docs/overrides
favicon: _static/favicon.ico
logo: _static/favicon.svg
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
primary: teal
accent: amber
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: yellow
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.indexes
- navigation.sections
- content.code.copy
- content.code.annotate
- content.tooltips
plugins:
- glightbox # expand images
- mkdocs-jupyter:
ignore_h1_titles: True
- search
- social:
cards_layout_options:
logo: docs/_static/favicon.svg
- mkdocstrings:
handlers:
python:
options:
show_bases: true
show_docstring_raises: true
show_source: false
show_root_heading: true
show_symbol_type_heading: true
show_symbol_type_toc: true
inherited_members: true
members_order: source
separate_signature: true
unwrap_annotated: true
filters:
- '!^_'
merge_init_into_class: true
docstring_section_style: table
signature_crossrefs: true
- termynal:
prompt_literal_start:
- "$"
- ">"
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/kayjan
- icon: fontawesome/brands/linkedin
link: https://linkedin.com/in/kayjan
- icon: fontawesome/brands/medium
link: https://kayjanwong.medium.com
version:
provider: mike
markdown_extensions:
- admonition # !!! note
- attr_list # default
- md_in_html # default
- mdx_truly_sane_lists # nested bullet points
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight: # code snippet highlight
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite # code snippet highlight
- pymdownx.snippets # code snippet highlight
- pymdownx.superfences: # default
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- name: py
class: 'highlight'
format: !!python/object/apply:docs._static.playground.color_command_formatter
kwds:
init: |
from bigtree import *
validator: !!python/name:docs._static.playground.color_command_validator
- pymdownx.tabbed: # code snippet with tabs
alternate_style: true
extra_css:
- _static/custom.css
- _static/playground.css
extra_javascript:
- _static/custom.js
- _static/playground-config.js
- _static/playground.js
- https://cdn.jsdelivr.net/pyodide/v0.25.1/full/pyodide.js