Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
140 lines (139 loc) · 5.79 KB
/
Copy pathmkdocs.yml
File metadata and controls
140 lines (139 loc) · 5.79 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
site_name: Endurain documentation
repo_url: https://github.com/endurain-project/endurain
theme:
name: material
logo: assets/brand_logo_light_theme.png
favicon: assets/favicon.ico
font:
text: Inter
icon:
admonition:
alert: material/alert
note: material/information
tip: material/lightbulb-on
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
toggle:
icon: material/brightness-4
name: Switch to light mode
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets:
base_path: ["docs"]
hooks:
- mkdocs_hooks/auth_docs.py
extra_css:
- stylesheets/extra.css
extra_javascript:
- assets/javascripts/secret-tools.js
plugins:
- blog
- search
- swagger-ui-tag:
supportedSubmitMethods: []
- redirects:
redirect_maps:
getting-started/getting-started.md: getting-started/quick-start.md
getting-started/advanced-started.md: getting-started/advanced-setup.md
integrations/3rd-party-apps.md: features/integrations.md
integrations/3rd-party-services.md: features/integrations.md
developer-guide/authentication.md: integrate/authentication.md
developer-guide/supported-types.md: integrate/supported-types.md
developer-guide/import-dev-notes.md: features/importing.md
reference/server_settings.md: reference/server-settings.md
reference/activities/activity_streams.md: reference/activities.md
reference/activities/activity_summary.md: reference/activities.md
reference/activities/activity_workout_steps.md: reference/activities.md
reference/activities/activity_file_import.md: reference/activities.md
reference/authentication/password_reset_tokens.md: reference/authentication.md
reference/authentication/sign_up_tokens.md: reference/authentication.md
reference/gears/gears.md: reference/gears.md
reference/gears/gear_components.md: reference/gears.md
reference/health/health_sleep.md: reference/health.md
reference/health/health_steps.md: reference/health.md
reference/health/health_targets.md: reference/health.md
reference/health/health_water.md: reference/health.md
reference/health/health_weight.md: reference/health.md
reference/health/health_poop.md: reference/health.md
reference/users/users.md: reference/users.md
reference/users/users_profile.md: reference/users.md
reference/users/users_goals.md: reference/users.md
reference/users/users_default_gear.md: reference/users.md
reference/users/users_integrations.md: reference/users.md
reference/users/users_privacy_settings.md: reference/users.md
- mkdocstrings:
handlers:
python:
options:
docstring_style: google
show_source: true
separate_signature: true
nav:
- Home: index.md
- Getting started:
- Quick start: getting-started/quick-start.md
- Reverse proxy: getting-started/reverse-proxy.md
- Updates and backups: getting-started/operations.md
- Troubleshooting: getting-started/troubleshooting.md
- Advanced setup: getting-started/advanced-setup.md
- Scaling and background jobs: getting-started/scaling-and-background-jobs.md
- Bare-metal installation: getting-started/bare-metal.md
- Proxmox community script: https://community-scripts.github.io/ProxmoxVE/scripts?id=endurain&category=Gaming+%26+Leisure
- User guide:
- Importing data: features/importing.md
- Sharing, privacy and followers: features/sharing-and-privacy.md
- Exporting and importing your data: features/export-import.md
- Single Sign-On (SSO): features/single-sign-on.md
- Sleep scoring: features/sleep-scoring.md
- Integrations: features/integrations.md
- Gallery: gallery.md
- Tools: tools.md
- Integrate:
- Authentication: integrate/authentication.md
- Account security: integrate/account-security.md
- API keys: integrate/api-keys.md
- OAuth/SSO and PKCE: integrate/oauth-sso-pkce.md
- Configuration, scopes and best practices: integrate/auth-reference.md
- Errors, concurrency and rate limits: integrate/errors-and-limits.md
- Supported types: integrate/supported-types.md
- API reference (OpenAPI): integrate/api-reference.md
- Contributing:
- Setup a development environment: developer-guide/setup-dev-env.md
- Module structure: developer-guide/module-structure.md
- Activity ingestion: developer-guide/activity-ingestion.md
- Events and subscribers: developer-guide/events-and-subscribers.md
- Auth boundary: developer-guide/auth-boundary.md
- Brand & UX guidelines: developer-guide/brand-and-ux-guidelines.md
- Suggesting a login photo: developer-guide/login-photos.md
- Writing the documentation: developer-guide/writing-docs.md
- Backend reference:
- Activities: reference/activities.md
- Authentication: reference/authentication.md
- Followers: reference/followers.md
- Garmin Connect: reference/garmin.md
- Gears: reference/gears.md
- Health: reference/health.md
- Users: reference/users.md
- Migrations: reference/migrations.md
- Notifications: reference/notifications.md
- Server settings: reference/server-settings.md
- Strava: reference/strava.md
- WebSocket: reference/websocket.md
- Blog: blog/index.md
- Privacy policy: privacy/mobile-app-privacy-policy.md