-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
144 lines (135 loc) · 3.63 KB
/
mkdocs.yml
File metadata and controls
144 lines (135 loc) · 3.63 KB
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
site_name: UQDD - Hybrid Models
site_description: Documentation for the UQDD repository (models, data pipeline, analysis)
site_author: Bola Khalil
repo_url: https://github.com/CDDLeiden/uqdd
repo_name: CDDLeiden/uqdd
site_url: https://CDDLeiden.github.io/uqdd/
edit_uri: edit/main/docs/
theme:
name: material
language: en
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- navigation.instant
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.indexes
- navigation.expand
- toc.integrate
- search.suggest
- search.highlight
- content.code.copy
- content.action.edit
- content.tabs.link
icon:
repo: fontawesome/brands/github
# Logo and favicon can be added under docs/assets
logo: assets/logo.png
favicon: assets/favicon.png
markdown_extensions:
- admonition
- toc:
permalink: true
- footnotes
- def_list
- attr_list
- md_in_html
- tables
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed
- pymdownx.emoji:
emoji_generator: materialx.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.arithmatex:
generic: true
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [ '.' ]
options:
# Structure
show_root_heading: true
show_object_full_path: true
show_submodules: true
members: true
inherited_members: true
members_order: source
# Signatures
separate_signature: true
show_signature: true
show_signature_annotations: true
line_length: 88
# Docstrings
docstring_style: numpy
docstring_section_style: table
merge_init_into_class: true
# Filters: exclude private and dunder names globally
filters: [ "!^_", "!^__" ]
- mike
- git-revision-date-localized:
fallback_to_build_date: true
enable_creation_date: true
enable_git_follow: true
- tags
- autorefs
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/CDDLeiden/uqdd
name: GitHub
homepage: https://CDDLeiden.github.io/uqdd/
extra_css:
- styles/overrides.css
extra_javascript:
- assets/javascripts/config.js
- assets/javascripts/toc-collapse.js
nav:
- Home: index.md
- Getting Started:
- Overview: getting-started/overview.md
- Installation: getting-started/installation.md
- Quickstart: getting-started/quickstart.md
- User Guide:
- Data Pipeline: user-guide/data.md
- Models & Training: user-guide/models.md
- Configuration: user-guide/configuration.md
- Metrics & Analysis: user-guide/metrics.md
- Notebooks: user-guide/notebooks.md
- API Reference:
- Package:
- UQDD Package: api/uqdd/index.md
- Data Processing: api/uqdd/data.md
- Models: api/uqdd/models.md
- Metrics: api/uqdd/metrics.md
- Core Utilities: api/uqdd/utils.md
- Reference:
- Project Structure: reference/project-structure.md
- CLI & Scripts: reference/scripts.md
- Reproducibility: reference/reproducibility.md
- Paper Mind Map: reference/mind-map.md
- Tags: tags.md
- Changelog: changelog.md
watch:
- uqdd
- docs
- scripts