-
Notifications
You must be signed in to change notification settings - Fork 10
/
mkdocs.yml
129 lines (117 loc) · 3.2 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
site_name: NAVIX
site_author: Eduardo Pignatelli
site_description: A reimplementation of MiniGrid in JAX
site_url: https://epignatelli/navix
# GitHub
repo_name: epignatelli/navix
repo_url: https://github.com/epignatelli/navix
use_directory_urls: false
# mkdocstrings
watch:
- navix
nav:
- Home:
- Welcome: index.md
- Environments: home/environments.md
- Install: install/index.md
- Quickstart:
- "Getting started": examples/getting_started.ipynb
- "PPO": examples/ppo.ipynb
# - "Customizing envs": examples/customisation.ipynb
- Benchmarks:
- "Timesteps": benchmarks/timesteps.ipynb
- "Environments": benchmarks/envs.ipynb
- API: api/
- Changelog: https://github.com/epignatelli/navix/releases
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/epignatelli/navix
- icon: fontawesome/brands/python
link: https://pypi.org/project/navix/
- icon: fontawesome/brands/twitter
link: https://twitter.com/edupignatelli
- icon: fontawesome/brands/google-scholar
link: https://github.com/epignatelli/navix
extra_css:
- assets/stylesheets/extra.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
extra_javascript:
- 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
- https://unpkg.com/mermaid/dist/mermaid.min.js
theme:
name: "material"
logo: assets/images/navix_logo.png
font:
text: Roboto
code: Roboto Mono
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.instant
- navigation.footer
- navigation.tabs
- navigation.top
- navigation.path
- search.highlight
- search.share
- search.suggest
- toc.follow
- toc.integrate
palette:
- scheme: default
primary: pink
accent: red
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: pink
accent: red
toggle:
icon: material/weather-sunny
name: Switch to light mode
plugins:
- mkdocs-jupyter:
remove_tag_config:
remove_input_tags:
- hide_input
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: google
show_bases: true
show_source: false
heading_level: 3
show_root_full_path: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_signature: true
show_signature_annotations: false
signature_crossrefs: false
- search
- gen-files:
scripts:
- docs/scripts/gen_doc_stubs.py # or any other name or path
- literate-nav:
nav_file: SUMMARY.md
markdown_extensions:
- toc:
toc_depth: 5
- pymdownx.highlight
- pymdownx.snippets:
check_paths: true
- admonition
- attr_list
- footnotes
- pymdownx.details # For collapsible admonitions
- pymdownx.superfences
copyright: Copyright © 2023 - 2024 NAVIX Authors