-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
54 lines (48 loc) · 1.58 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
site_name: fenbux
site_description: The documentation for the fenbux software library.
site_author: Yaobo Jia
repo_url: https://github.com/jiayaobo/fenbux
repo_name: jiayaobo/fenbux
theme:
name: material
palette:
- scheme: default
primary: white
accent: amber
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: black
accent: amber
toggle:
icon: material/weather-sunny
name: Switch to light mode
markdown_extensions:
- pymdownx.arithmatex: # Render LaTeX via MathJax
generic: true
- pymdownx.superfences # Seems to enable syntax highlighting when used with the Material theme.
- pymdownx.details # Allowing hidden expandable regions denoted by ???
- pymdownx.snippets: # Include one Markdown file into another
base_path: docs
plugins:
- autorefs
- mknotebooks
- mkdocstrings:
handlers:
python:
setup_commands:
- import pytkdocs_tweaks
- pytkdocs_tweaks.main()
- import jaxtyping
- jaxtyping.set_array_name_format("array")
selection:
inherited_members: true
rendering:
show_root_heading: true
show_root_full_path: true
show_if_no_docstring: true
show_signature_annotations: true
show_source: false
members_order: source
heading_level: 4