-
Notifications
You must be signed in to change notification settings - Fork 9
/
Copy pathmkdocs.yml
115 lines (111 loc) · 3.97 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
site_name: Med-ImageTools Documentation
site_url: https://bhklab.github.io/med-imagetools
repo_url: https://github.com/bhklab/med-imagetools
watch: [docs, src, mkdocs.yml]
dev_addr: "127.0.0.1:8001"
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- attr_list
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- mkdocs-click
extra:
homepage: https://bhklab.github.io/med-imagetools
social:
#######################################################################################
# https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links
- icon: fontawesome/brands/github
link: https://github.com/bhklab/
name: Check out our GitHub!
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/bhklab/
name: Connect with us on LinkedIn!
generator: false # disable 'built with MkDocs' footer
theme:
name: material
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.highlight
- search.suggest
- toc.follow
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: lime
toggle:
icon: material/weather-night
name: Switch to system preference
plugins:
- awesome-pages # simplifies configuring page titles and their order
- search # necessary for search functionality to work
- git-authors # adds authors to pages using git history
- include-markdown # allows for including Markdown files into another Markdown file
- mkdocs-jupyter:
allow_errors: false
include_source: true
- mkdocstrings:
handlers:
python:
paths: [src/imgtools/dicom/sort, src/imgtools/io]
options:
extensions:
- griffe_inherited_docstrings:
merge: true
# docstrings
docstring_style: numpy
docstring_options:
ignore_init_summary: true # Ignore the first line in __init__ methods' docstrings.
warn_unknown_params: true # Warn about parameters documented in docstrings that do not appear in the signature. Default: true.
show_docstring_examples: true
show_docstring_raises: false
docstring_section_style: table
filters: ["!^_"]
# heading_level: 1
merge_init_into_class: true
inherited_members: true
parameter_headings: true
relative_crossrefs: true
scoped_crossrefs: true
show_bases: false
show_inheritance_diagram: true
show_root_heading: true
show_root_full_path: false
# Signatures
annotations_path: full
modernize_annotations: true # https://mkdocstrings.github.io/python/usage/configuration/signatures/#modernize_annotations
separate_signature: true # https://mkdocstrings.github.io/python/usage/configuration/signatures/#separate_signature
show_signature_annotations: true
signature_crossrefs: true
unwrap_annotated: true
# show_source: false
show_symbol_type_heading: true
show_symbol_type_toc: true
summary:
functions: true