-
Notifications
You must be signed in to change notification settings - Fork 82
/
mkdocs.yml
109 lines (105 loc) · 3 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
site_name: Levanter
repo_url: https://github.com/stanford-crfm/levanter/
edit_uri: blob/main/docs/
theme:
name: readthedocs
# name: material
# highlightjs: false
# features:
# - content.code.copy
markdown_extensions:
- attr_list
- admonition
- def_list
- pymdownx.tasklist:
custom_checkbox: true
#- callouts
- footnotes
- codehilite
- pymdownx.details # Allowing hidden expandable regions denoted by ???
- pymdownx.magiclink
- pymdownx.superfences
- pymdownx.arithmatex: # Render LaTeX via MathJax
generic: true
- pymdownx.superfences # Seems to enable syntax highlighting when used with the Material theme.
- pymdownx.snippets: # Include one Markdown file into another
base_path: docs
- pymdownx.inlinehilite
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- toc:
permalink: "¤"
toc_depth: "1-3"
plugins:
- search
- autorefs
- mkdocstrings:
handlers:
python:
setup_commands:
- import pytkdocs_tweaks
- pytkdocs_tweaks.main()
paths: [src]
import:
- https://docs.python.org/3/objects.inv
- https://jax.readthedocs.io/en/latest/objects.inv
- https://haliax.readthedocs.io/en/latest/objects.inv
- https://docs.kidger.site/equinox/objects.inv
options:
docstring_options:
ignore_init_summary: true
docstring_style: google
show_if_no_docstring: true
show_source: false
docstring_section_style: list
heading_level: 4
inherited_members: true
merge_init_into_class: true
load_external_modules: true
preload_modules: [haliax, haliax.core]
# separate_signature: true
show_root_heading: true
show_root_full_path: false
# show_signature_annotations: true
show_symbol_type_heading: false
show_symbol_type_toc: false
signature_crossrefs: true
line_length: 100
- include-markdown
extra_css:
- css/mkdocstrings.css
- css/custom.css
- css/friendly.css
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
watch:
- src
- docs
nav:
- 'Home': 'index.md'
- 'Installation and Setup':
- 'Installation.md'
- 'Getting-Started-TPU-VM.md'
- 'Getting-Started-GPU.md'
- 'User Guide':
- 'Getting-Started-Training.md'
- "Training-On-Your-Data.md"
- 'Configuration-Guide.md'
- 'Performance-Guide.md'
- 'Tutorials':
- "Fine-Tuning.md"
- "LoRA.md"
- "tutorials/Fine-Tuning-Semantic-Parsing.md"
- "Hardware-Agnostic-Training.md"
- "tutorials/Training-On-Audio-Data.md"
- 'Developer Guide':
- 'dev/Port-Models.md'
- 'dev/Trackers.md'
- 'dev/GPU-Docker-Dev.md'
- 'FAQ' : 'faq.md'
- Other:
- 'Levanter-1.0-Release.md'
- "design/Data-Loader-Design.md"