-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathmkdocs.yml
132 lines (122 loc) · 3.35 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
site_name: odrpack
site_url: https://hugomvale.github.io/odrpack-python/
site_author: Hugo Vale
site_description: >-
A package for weighted orthogonal distance regression (ODR).
repo_name: HugoMVale/odrpack-python
repo_url: https://github.com/HugoMVale/odrpack-python
edit_uri: "" #disables edit button
copyright: Copyright © 2024 Hugo Vale
theme:
name: material
language: en
features:
- search.highlight
- search.suggest
- navigation.instant
- navigation.instant.prefetch
# - navigation.tabs
# - navigation.tabs.sticky
- navigation.indexes
- navigation.path
- navigation.top
- toc.follow
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
watch:
- src/odrpack
- docs/examples
- docs/reference
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [src]
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/stable/objects.inv
options:
modernize_annotations: true
docstring_section_style: spacy
group_by_category: false
# show_category_heading: true
show_source: true
members_order: alphabetical
docstring_style: numpy
show_root_toc_entry: false
show_bases: false
separate_signature: true
show_signature_annotations: true
inherited_members: true
merge_init_into_class: false
show_symbol_type_toc: true
show_category_heading: false
- mkdocs-jupyter:
include: ["*.ipynb"]
include_source: false
ignore_h1_titles: true
markdown_extensions:
- admonition
- attr_list
- footnotes
- pymdownx.details
- pymdownx.superfences
- pymdownx.caret
- pymdownx.mark
- pymdownx.tilde
- pymdownx.highlight
- pymdownx.magiclink
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.snippets:
base_path:
- docs
check_paths: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.arithmatex:
generic: true
- pymdownx.tasklist:
custom_checkbox: true
- toc:
permalink: "¤"
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:
- css/mkdocstrings.css
- https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/HugoMVale
- icon: fontawesome/brands/python
link: https://pypi.org/project/odrpack/
- icon: fontawesome/brands/linkedin
link: https://de.linkedin.com/in/hugo-vale-8b65948a
nav:
- Home:
- index.md
- Examples:
- Explicit model: examples/explicit-model.ipynb
- Implicit model: examples/implicit-model.ipynb
- API Reference: reference/index.md