forked from Weizhe-Chen/PyPolo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
114 lines (113 loc) · 3.36 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: PyPolo
site_url: https://pypolo.readthedocs.io/
repo_url: https://github.com/Weizhe-Chen/PyPolo
repo_name: GitHub/PyPolo
copyright: Copyright © 2022 - 2023 PyPolo Developers
nav:
- Introduction: index.md
- Installation: installation.md
- Tutorials:
- Gaussian Process Regression: tutorials/gaussian_process_regression.md
- Resources:
- Books: resources/books.md
- Videos: resources/videos.md
- Workshops: resources/workshops.md
- Code: resources/code.md
- Papers: resources/papers.md
- Thesis: resources/thesis.md
- Developers:
- Contributing: developers/contributing.md
- Framework: developers/framework.md
- Models: developers/models.md
- Objectives: developers/objectives.md
- Planners: developers/planners.md
- Controllers: developers/controllers.md
- Sensors: developers/sensors.md
- Robots: developers/robots.md
- Tasks: developers/tasks.md
theme:
name: material
custom_dir: docs/overrides
icon:
repo: fontawesome/brands/github
logo: assets/images/social/logo.svg
favicon: assets/images/social/logo.svg
features:
- navigation.instant
- navigation.tracking
- navigation.top
- header.autohide
- navigation.footer
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: grey
toggle:
icon: material/weather-sunny
name: Switch to light mode
plugins:
- search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
- mkdocstrings:
handlers:
python:
paths: [pypolo]
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
options:
heading_level: 2
show_root_heading: no
show_root_full_path: no
show_root_toc_entry: no
show_category_heading: no
show_submodules: no
group_by_category: yes
docstring_style: google
docstring_section_style: table
line_length: 80
merge_init_into_class: yes
ignore_init_summary: no
show_if_no_docstring: no
show_signature: yes
show_signature_annotations: no
separate_signature: yes
show_bases: yes
show_source: yes
markdown_extensions:
- def_list
- pymdownx.tasklist:
custom_checkbox: true
- attr_list
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
- pymdownx.arithmatex:
generic: true
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Weizhe-Chen/PyPolo
generator: false
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