Skip to content

Commit 7b234ea

Browse files
authored
Added new WK tutorials to navbar and replaced video embedding plugin for docs (#905)
* added new WK tutorials to navbar and replaced video embedding plugin * applied PR feedback
1 parent 2554d80 commit 7b234ea

File tree

4 files changed

+1505
-1449
lines changed

4 files changed

+1505
-1449
lines changed

docs/md_extensions/video_embed_extension.py

Lines changed: 0 additions & 39 deletions
This file was deleted.

docs/mkdocs.yml

Lines changed: 127 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ theme:
1515
icon:
1616
repo: fontawesome/brands/github
1717
font: false
18-
### pdoc sites don't invert the text color in dark-mode
18+
### pdoc sites don't invert the text color in dark-mode
1919
# palette:
2020
# - media: "(prefers-color-scheme: light)"
2121
# scheme: default
@@ -35,129 +35,133 @@ theme:
3535
- navigation.top
3636

3737
nav:
38-
- WEBKNOSSOS:
39-
- webknossos/index.md
40-
- webknossos/getting_started.md
41-
- Guides:
42-
- webknossos/dashboard.md
43-
- webknossos/skeleton_annotation.md
44-
- webknossos/volume_annotation.md
45-
- webknossos/tracing_ui.md
46-
- webknossos/mesh_visualization.md
47-
- webknossos/datasets.md
48-
- Managing Users & Permissions: webknossos/users.md
49-
- webknossos/tasks.md
50-
- webknossos/sharing.md
51-
- webknossos/installation.md
52-
- webknossos/automated_analysis.md
53-
- webknossos/jobs.md
54-
- webknossos/tooling.md
55-
- webknossos/export.md
56-
- webknossos/proof_reading.md
57-
- webknossos/connectome_viewer.md
58-
- Reference:
59-
- webknossos/terminology.md
60-
- webknossos/data_formats.md
61-
- Keyboard Shortcuts: webknossos/keyboard_shortcuts.md
62-
- Backend REST API: webknossos/rest_api.md
63-
- Frontend Scripting API: https://webknossos.org/assets/docs/frontend-api/index.html" target="_blank
64-
- Changelog: webknossos/CHANGELOG.released.md
65-
- Migration Guide: webknossos/MIGRATIONS.released.md
66-
- Community:
67-
- Publications: webknossos/publications.md
68-
- GitHub: https://github.com/scalableminds/webknossos" target="_blank
69-
- Blog: https://medium.com/scalableminds" target="_blank
70-
- Getting Help:
71-
- webknossos/faq.md
72-
- Community Support: https://forum.image.sc/tag/webknossos" target="_blank
73-
- Email Support: mailto:[email protected]
74-
- Commercial Support: https://scalableminds.com" target="_blank
75-
- Python Library:
76-
- webknossos-py/index.md
77-
- webknossos-py/installation.md
78-
- Usage Examples:
79-
- Dataset Examples:
80-
- webknossos-py/examples/dataset_usage.md
81-
- webknossos-py/examples/upload_tiff_stack.md
82-
- webknossos-py/examples/upload_image_data.md
83-
- webknossos-py/examples/create_dataset_from_images.md
84-
- webknossos-py/examples/image_stack_to_dataset.md
85-
- webknossos-py/examples/download_image_data.md
86-
- webknossos-py/examples/download_tiff_stack.md
87-
- webknossos-py/examples/remote_datasets.md
88-
- webknossos-py/examples/zarr_and_dask.md
89-
- Annotation Examples:
90-
- webknossos-py/examples/apply_merger_mode.md
91-
- webknossos-py/examples/learned_segmenter.md
92-
- webknossos-py/examples/skeleton_synapse_candidates.md
93-
- webknossos-py/examples/calculate_segment_sizes.md
94-
- webknossos-py/examples/download_segments.md
95-
- Administration Examples:
96-
- webknossos-py/examples/user_times.md
97-
- webknossos-py/examples/annotation_project_administration.md
98-
- API Reference:
99-
- Overview: api/webknossos.md
100-
- Geometry:
101-
- BoundingBox: api/webknossos/geometry/bounding_box.md
102-
- Mag: api/webknossos/geometry/mag.md
103-
- Vec3Int: api/webknossos/geometry/vec3_int.md
104-
- Dataset:
105-
- Dataset: api/webknossos/dataset/dataset.md
106-
- Layer: api/webknossos/dataset/layer.md
107-
- MagView: api/webknossos/dataset/mag_view.md
108-
- View: api/webknossos/dataset/view.md
109-
- Annotation: api/webknossos/annotation/annotation.md
110-
- Skeleton:
111-
- Skeleton: api/webknossos/skeleton/skeleton.md
112-
- Group: api/webknossos/skeleton/group.md
113-
- Tree: api/webknossos/skeleton/tree.md
114-
- Node: api/webknossos/skeleton/node.md
115-
- Authentication & Server Context: api/webknossos/client/context.md
116-
- Administration:
117-
- User: api/webknossos/administration/user.md
118-
- Project: api/webknossos/administration/project.md
119-
- Task: api/webknossos/administration/task.md
120-
- Version Changelog:
121-
- webknossos-py/stability_policy.md
122-
- webknossos-py/changelog.md
123-
- Community:
124-
- webknossos-py/CONTRIBUTING.md
125-
- webknossos-py/CODE_OF_CONDUCT.md
126-
- webknossos/terminology.md
127-
- Getting Help:
128-
- Community Support: https://forum.image.sc/tag/webknossos" target="_blank
129-
- Email Support: mailto:[email protected]
130-
- Commercial Support: https://scalableminds.com" target="_blank
131-
- GitHub: https://github.com/scalableminds/webknossos-libs/tree/master/webknossos" target="_blank
132-
- Blog: https://medium.com/scalableminds" target="_blank
133-
- WEBKNOSSOS Cuber:
134-
- wkcuber CLI: wkcuber/index.md
135-
- wkcuber/changelog.md
136-
- Getting Help:
137-
- Community Support: https://forum.image.sc/tag/webknossos" target="_blank
138-
- Email Support: mailto:[email protected]
139-
- Commercial Support: https://scalableminds.com" target="_blank
140-
- GitHub: https://github.com/scalableminds/webknossos-libs/tree/master/wkcuber" target="_blank
38+
- WEBKNOSSOS:
39+
- webknossos/index.md
40+
- webknossos/getting_started.md
41+
- Guides:
42+
- webknossos/dashboard.md
43+
- webknossos/skeleton_annotation.md
44+
- webknossos/volume_annotation.md
45+
- webknossos/tracing_ui.md
46+
- webknossos/mesh_visualization.md
47+
- webknossos/datasets.md
48+
- Managing Users & Permissions: webknossos/users.md
49+
- webknossos/tasks.md
50+
- webknossos/sharing.md
51+
- webknossos/installation.md
52+
- webknossos/automated_analysis.md
53+
- webknossos/jobs.md
54+
- webknossos/tooling.md
55+
- webknossos/export.md
56+
- webknossos/proof_reading.md
57+
- webknossos/connectome_viewer.md
58+
- Tutorials:
59+
- Volume Annotation: webknossos/tutorial_volume_annotation.md
60+
- Data Sharing: webknossos/tutorial_data_sharing.md
61+
- Reference:
62+
- webknossos/terminology.md
63+
- webknossos/data_formats.md
64+
- Keyboard Shortcuts: webknossos/keyboard_shortcuts.md
65+
- Backend REST API: webknossos/rest_api.md
66+
- Frontend Scripting API: https://webknossos.org/assets/docs/frontend-api/index.html" target="_blank
67+
- Changelog: webknossos/CHANGELOG.released.md
68+
- Migration Guide: webknossos/MIGRATIONS.released.md
69+
- Community:
70+
- Publications: webknossos/publications.md
71+
- GitHub: https://github.com/scalableminds/webknossos" target="_blank
72+
- Blog: https://medium.com/scalableminds" target="_blank
73+
- Getting Help:
74+
- webknossos/faq.md
75+
- Community Support: https://forum.image.sc/tag/webknossos" target="_blank
76+
- Email Support: mailto:[email protected]
77+
- Commercial Support: https://scalableminds.com" target="_blank
78+
- Python Library:
79+
- webknossos-py/index.md
80+
- webknossos-py/installation.md
81+
- Usage Examples:
82+
- Dataset Examples:
83+
- webknossos-py/examples/dataset_usage.md
84+
- webknossos-py/examples/upload_tiff_stack.md
85+
- webknossos-py/examples/upload_image_data.md
86+
- webknossos-py/examples/create_dataset_from_images.md
87+
- webknossos-py/examples/image_stack_to_dataset.md
88+
- webknossos-py/examples/download_image_data.md
89+
- webknossos-py/examples/download_tiff_stack.md
90+
- webknossos-py/examples/remote_datasets.md
91+
- webknossos-py/examples/zarr_and_dask.md
92+
- Annotation Examples:
93+
- webknossos-py/examples/apply_merger_mode.md
94+
- webknossos-py/examples/learned_segmenter.md
95+
- webknossos-py/examples/skeleton_synapse_candidates.md
96+
- webknossos-py/examples/calculate_segment_sizes.md
97+
- webknossos-py/examples/download_segments.md
98+
- Administration Examples:
99+
- webknossos-py/examples/user_times.md
100+
- webknossos-py/examples/annotation_project_administration.md
101+
- API Reference:
102+
- Overview: api/webknossos.md
103+
- Geometry:
104+
- BoundingBox: api/webknossos/geometry/bounding_box.md
105+
- Mag: api/webknossos/geometry/mag.md
106+
- Vec3Int: api/webknossos/geometry/vec3_int.md
107+
- Dataset:
108+
- Dataset: api/webknossos/dataset/dataset.md
109+
- Layer: api/webknossos/dataset/layer.md
110+
- MagView: api/webknossos/dataset/mag_view.md
111+
- View: api/webknossos/dataset/view.md
112+
- Annotation: api/webknossos/annotation/annotation.md
113+
- Skeleton:
114+
- Skeleton: api/webknossos/skeleton/skeleton.md
115+
- Group: api/webknossos/skeleton/group.md
116+
- Tree: api/webknossos/skeleton/tree.md
117+
- Node: api/webknossos/skeleton/node.md
118+
- Authentication & Server Context: api/webknossos/client/context.md
119+
- Administration:
120+
- User: api/webknossos/administration/user.md
121+
- Project: api/webknossos/administration/project.md
122+
- Task: api/webknossos/administration/task.md
123+
- Version Changelog:
124+
- webknossos-py/stability_policy.md
125+
- webknossos-py/changelog.md
126+
- Community:
127+
- webknossos-py/CONTRIBUTING.md
128+
- webknossos-py/CODE_OF_CONDUCT.md
129+
- webknossos/terminology.md
130+
- Getting Help:
131+
- Community Support: https://forum.image.sc/tag/webknossos" target="_blank
132+
- Email Support: mailto:[email protected]
133+
- Commercial Support: https://scalableminds.com" target="_blank
134+
- GitHub: https://github.com/scalableminds/webknossos-libs/tree/master/webknossos" target="_blank
135+
- Blog: https://medium.com/scalableminds" target="_blank
136+
- WEBKNOSSOS Cuber:
137+
- wkcuber CLI: wkcuber/index.md
138+
- wkcuber/changelog.md
139+
- Getting Help:
140+
- Community Support: https://forum.image.sc/tag/webknossos" target="_blank
141+
- Email Support: mailto:[email protected]
142+
- Commercial Support: https://scalableminds.com" target="_blank
143+
- GitHub: https://github.com/scalableminds/webknossos-libs/tree/master/wkcuber" target="_blank
141144

142145
plugins:
143-
- search
144-
- redirects:
145-
redirect_maps:
146-
'index.md': 'webknossos/index.md'
146+
- search
147+
- redirects:
148+
redirect_maps:
149+
"index.md": "webknossos/index.md"
150+
- mkdocs-video:
151+
is_video: True
147152

148153
markdown_extensions:
149-
- admonition
150-
- attr_list
151-
- md_in_html
152-
- md_extensions.pdoc_toc_extension
153-
- md_extensions.video_embed_extension
154-
- md_extensions.mdlightbox
155-
- pymdownx.highlight
156-
- pymdownx.inlinehilite
157-
- pymdownx.superfences
158-
- pymdownx.snippets:
159-
base_path: ".."
160-
check_paths: true
161-
- pymdownx.emoji:
162-
emoji_index: !!python/name:materialx.emoji.twemoji
163-
emoji_generator: !!python/name:materialx.emoji.to_svg
154+
- admonition
155+
- attr_list
156+
- md_in_html
157+
- md_extensions.pdoc_toc_extension
158+
- md_extensions.mdlightbox
159+
- pymdownx.highlight
160+
- pymdownx.inlinehilite
161+
- pymdownx.superfences
162+
- pymdownx.snippets:
163+
base_path: ".."
164+
check_paths: true
165+
- pymdownx.emoji:
166+
emoji_index: !!python/name:materialx.emoji.twemoji
167+
emoji_generator: !!python/name:materialx.emoji.to_svg

0 commit comments

Comments
 (0)