-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
111 lines (110 loc) · 3.54 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
---
theme:
name: material
features:
- navigation.sections
- navigation.path
- navigation.indexes
- search.suggest
- search.highlight
palette:
- scheme: default
primary: white
accent: amber
toggle:
icon: material/eye
name: Switch to dark mode
- scheme: slate
primary: black
accent: amber
toggle:
icon: material/eye-outline
name: Switch to light mode
icon:
repo: fontawesome/brands/github
font:
text: Fira Sans
site_name: probdiffeq documentation
site_description: The documentation for the probdiffeq library.
site_author: Nicholas Krämer
strict: true
repo_url: https://github.com/pnkraemer/probdiffeq
repo_name: pnkraemer/probdiffeq
# Credit for a good amount of this setup: https://github.com/patrick-kidger/diffrax
extra_css: [_stylesheets/extra.css]
markdown_extensions:
- pymdownx.arithmatex:
generic: true
- pymdownx.superfences
- pymdownx.details
- pymdownx.snippets:
base_path: docs
- admonition
- toc:
permalink: ¤
toc_depth: 3
extra_javascript:
# Credit:
# https://github.com/patrick-kidger/diffrax
# and https://squidfunk.github.io/mkdocs-material/reference/mathjax/
- _javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
docstring_style: numpy
show_signature_annotations: true
- exclude:
glob:
- examples*/*.py
- examples*/*.ipynb_*
- benchmarks*/**/*.md
- benchmarks*/**/*.py
- mkdocs-jupyter
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/@pnkraemer
name: pnkraemer
generator: false
nav:
- Probabilistic solvers for differential equations in JAX: index.md
- An easy example: examples_quickstart/easy_example.ipynb
- 'FAQ: PROBDIFFEQ 101':
- Transitioning from other packages: getting_started/transitioning_from_other_packages.md
- Choosing a solver: getting_started/choosing_a_solver.md
- Troubleshooting: getting_started/troubleshooting.md
- SOLVER CONFIGURATION:
- examples_solver_config/conditioning-on-zero-residual.ipynb
- examples_solver_config/posterior_uncertainties.ipynb
- examples_solver_config/dynamic_output_scales.ipynb
- examples_solver_config/second_order_problems.ipynb
- PARAMETER ESTIMATION:
- Parameter estimation with Optax: examples_parameter_estimation/physics_enhanced_regression_1.ipynb
- Parameter estimation with BlackJAX: examples_parameter_estimation/physics_enhanced_regression_2.ipynb
- Neural ODEs with Optax: examples_parameter_estimation/neural_ode.ipynb
- MISCELLANEOUS EXAMPLES:
- examples_misc/use_equinox_bounded_while_loop.ipynb
- API DOCUMENTATION:
- ivpsolve: api_docs/ivpsolve.md
- ivpsolvers: api_docs/ivpsolvers.md
- stats: api_docs/stats.md
- taylor: api_docs/taylor.md
- impl: api_docs/impl.md
- DEVELOPER DOCUMENTATION:
- Changelog: dev_docs/changelog.md
- dev_docs/public_api.md
- dev_docs/creating_example_notebook.md
- dev_docs/continuous_integration.md
- BENCHMARKS:
- benchmarks/lotkavolterra/plot.ipynb
- benchmarks/pleiades/plot.ipynb
- benchmarks/hires/plot.ipynb
- benchmarks/vanderpol/plot.ipynb
- benchmarks/taylor_pleiades/plot.ipynb
- benchmarks/taylor_fitzhughnagumo/plot.ipynb
- benchmarks/taylor_node/plot.ipynb