-
Notifications
You must be signed in to change notification settings - Fork 20
/
Copy pathmkdocs.yml
114 lines (107 loc) · 3.18 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
# Check https://www.mkdocs.org/user-guide/configuration/
# for more MkDocs configuration details
site_name: Tactics2d
site_url: https://tactics2d.readthedocs.io/en/latest/
site_description: The official documentation of Tactics2d.
site_author: WoodOxen
repo_url: https://github.com/WoodOxen/tactics2d
docs_dir: docs
nav:
- Home: "index.md"
- Release Notes: "release_notes.md"
- Installation: "installation.md"
- Tutorial:
- Visualize Interpolation: "./tutorial/interpolator_visualization.ipynb"
- Visualize Datasets: "./tutorial/dataset_visualization.ipynb"
- Train an Agent in Parking Environment: "./tutorial/train_parking_demo.ipynb"
- Dataset Support: "./dataset-support/dataset-support.md"
- Python API:
- tactics2d.dataset_parser: "api/dataset_parser.md"
- tactics2d.envs: "api/envs.md"
- tactics2d.map: "api/map.md"
- tactics2d.math: "api/math.md"
- tactics2d.participant: "api/participant.md"
- tactics2d.physics: "api/physics.md"
- tactics2d.sensor: "api/sensor.md"
- tactics2d.traffic: "api/traffic.md"
- Community: "community.md"
- Publications: "publication.md"
theme:
name: "material"
icon:
admonition:
note: octicons/tag-16
abstract: octicons/checklist-16
info: octicons/info-16
tip: octicons/squirrel-16
success: octicons/check-16
question: octicons/question-16
warning: octicons/alert-16
failure: octicons/x-circle-16
danger: octicons/zap-16
bug: octicons/bug-16
example: octicons/beaker-16
quote: octicons/quote-16
palette:
# Palette toggle for light mode
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: "Roboto Slab"
code: "Ubuntu Mono"
features:
- content.action.view
- content.code.copy
- content.code.prettify
- navigation.expand
- navigation.footer
- search.suggest
plugins:
- glightbox
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_source: false
heading_level: 1
show_root_heading: true
- mkdocs-jupyter:
execute: false
include_requirejs: true
include_source: true
kernel_name: python3
- search
markdown_extensions:
- abbr
- admonition
- attr_list
- pymdownx.details
- pymdownx.superfences
- pymdownx.emoji
extra_javascript:
- javascripts/katex.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
- css/extra_for_material.css