forked from danielkelshaw/riemax
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
169 lines (137 loc) · 3.79 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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
site_name: Riemax
site_url: https://riemax.danielkelshaw.com
repo_url: https://github.com/danielkelshaw/riemax
repo_name: danielkelshaw/riemax
theme:
name: material
language: en
palette:
# palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue grey
accent: red
toggle:
icon: material/toggle-switch
name: Switch to dark mode
# palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue grey
accent: red
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
features:
- navigation.sections
- header.autohide
- navigation.indexes
- navigation.instant
- navigation.instant.progress
- content.code.copy
- content.code.annotate
icon:
repo: fontawesome/brands/github
annotation: material/arrow-right-circle
extra:
generator: false
plugins:
- search
- mknotebooks:
enable_default_jupyter_cell_styling: false
- mkdocstrings:
handlers:
python:
options:
# general
show_bases: true
show_source: true
# headings
heading_level: 3
show_root_heading: true
show_root_full_path: true
show_root_members_full_path: true
# members
inherited_members: false
members_order: source
group_by_category: true
docstring_style: google
docstring_section_style: table
show_if_no_docstring: false
show_docstring_attributes: true
show_docstring_functions: true
show_docstring_description: true
show_docstring_parameters: true
show_docstring_returns: true
# signatures
annotations_path: full
line_length: 60
show_signature: true
show_signature_annotations: true
separate_signature: false
unwrap_annotated: true
markdown_extensions:
# tooltips
- abbr
- attr_list
- pymdownx.snippets
# annotations (w/ attr_list)
- md_in_html
- pymdownx.superfences
# admonitions (w/ pymdownx.superfences)
- admonition
- pymdownx.details
# custom lists
- def_list
- pymdownx.tasklist:
custom_checkbox: true
# code blocks (w/ pydownx.snippets, pydownx.superfences)
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
# tabs (w/ pymdownx.superfences)
- pymdownx.tabbed:
alternate_style: true
# footnotes
- footnotes
# formatting
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
# smart symbols
- pymdownx.smartsymbols
# maths
- pymdownx.arithmatex:
generic: true
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
copyright: Copyright © 2023 Daniel Kelshaw
nav:
- Getting Started: index.md
- Examples:
- Introduction to Riemax: 'examples/introduction.ipynb'
- Curvature-based Sampling: 'examples/curvature_sampling.ipynb'
- API:
- manifold:
- manifold/index.md
- geometry: manifold/geometry.md
- operators: manifold/operators.md
- geodesic: manifold/geodesic.md
- symplectic: manifold/symplectic.md
- maps: manifold/maps.md
- euclidean: manifold/euclidean.md
- numerical:
- numerical/index.md
- newton_raphson: numerical/newton_raphson.md
- integrators: numerical/integrators.md
- curves: numerical/curves.md
- sampling: numerical/sampling.md