-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
110 lines (104 loc) · 3.19 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
site_name: NeuroPython Workshop 2024
site_url: https://navis-org.github.io/neuropython2024/
site_description: Documentation and Materials for the NeuroPython workshop 2024
# strict: true
repo_name: navis-org/neuropython2024
repo_url: https://github.com/navis-org/neuropython2024
edit_uri: edit/main/docs/
nav:
- Home: index.md
- Schedule: schedule.md
- Preparation:
- preparing.md
# - NeMos: nemos/nemos_setup.md
# - Pynapple: pynapple/pynapple_setup.md
# - CAJAL: cajal/cajal_setup.md
# - Navis: navis/navis_setup.md
theme:
name: "material"
features:
- content.tabs.link
- content.code.annotate
- navigation.indexes
- navigation.instant
- content.code.copy
#logo: images/icon.png
# below option would prevents loading typefaces from Google Fonts
# but see also the privacy plugin below
#font: false
icon:
#logo: fontawesome/solid/eye
repo: fontawesome/brands/github
#favicon: images/icon.png
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: fontawesome/regular/lightbulb
name: "Switch to dark mode"
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: pink
accent: pink
toggle:
icon: fontawesome/solid/lightbulb
name: "Switch to light mode"
markdown_extensions:
- admonition
- abbr
- attr_list
- md_in_html
- pymdownx.snippets
- pymdownx.tasklist
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.extra
- pymdownx.highlight
- pymdownx.tabbed:
alternate_style: true
- tables
- toc:
permalink: "#"
plugins:
# the privacy plugin will bundle external assets (like Google Fonts)
# this should make the website GDPR compliant
- privacy
# the social plugin generates social cards for each page of the project
# which are used as previews when sharing links to the documentation
- social
- section-index
- search:
separator: '[\s\-\_,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
- autorefs
#- literate-nav
- minify:
minify_html: true
minify_js: true
minify_css: true
htmlmin_opts:
remove_comments: true
# css_files:
# - stylesheets/extra.css
- mkdocstrings:
handlers:
python:
import:
- https://docs.python.org/3/objects.inv
- https://numpy.org/doc/stable/objects.inv
options:
show_root_heading: true # default is false
docstring_style: "numpy"
line_length: 50 # default is 60
# show_if_no_docstring: true # default is false
# show_signature: false # default is true
show_signature_annotations: true # default is false
annotations_path: "source" # default is 'brief'
show_bases: false # default is true
show_source: false # default is true
docstring_section_style: "spacy" # default is "table" but the tables end up being too wide
- glightbox
extra_css:
- stylesheets/extra.css