forked from tinygrad/tinygrad
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
133 lines (130 loc) · 3.19 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
# pip install mkdocs mkdocs-material mkdocstrings[python]
site_name: tinygrad docs
site_url: https://docs.tinygrad.org/
repo_url: https://github.com/tinygrad/tinygrad/
nav:
- Home:
- index.md
- Quickstart: quickstart.md
- Showcase: showcase.md
- MNIST Tutorial: mnist.md
- API Reference:
- Tensor:
- tensor/index.md
- Creation: tensor/creation.md
- Movement: tensor/movement.md
- Ops: tensor/ops.md
- Function: function.md
- dtypes: dtypes.md
- nn (Neural Networks): nn.md
- Environment Variables: env_vars.md
- Developer: developer.md
- tinybox: tinybox.md
#- tinygrad: reference/
#extra_css:
#- css/tinygrad.css
markdown_extensions:
- attr_list
- admonition
- callouts
- footnotes
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
pygments_lang_class: true
- pymdownx.inlinehilite:
style_plain_text: python
- pymdownx.magiclink
- pymdownx.snippets:
base_path: [!relative $config_dir]
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- toc:
permalink: "¤"
theme:
name: material
logo: logo_tiny_dark.svg
favicon: favicon.svg
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.expand
- navigation.top
- navigation.path
- search.highlight
- search.suggest
- toc.follow
- toc.integrate
palette:
scheme: slate
primary: black
accent: lime
palette:
- media: "(prefers-color-scheme)"
accent: lime
primary: black
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
accent: lime
primary: black
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
accent: lime
primary: black
toggle:
icon: material/brightness-4
name: Switch to system preference
plugins:
- search
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
paths: [tinygrad]
options:
docstring_options:
ignore_init_summary: true
docstring_section_style: list
filters: ["!^_"]
heading_level: 3
inherited_members: false
merge_init_into_class: true
separate_signature: true
show_root_heading: true
show_root_full_path: false
show_signature_annotations: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_source: true
signature_crossrefs: true
summary: true
- markdown-exec
#- gen-files:
# scripts:
# - docs/gen_ref_pages.py
#- literate-nav:
# nav_file: SUMMARY.md