-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
126 lines (116 loc) · 3.03 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
116
117
118
119
120
121
122
123
124
125
126
site_name: "TemporalScope"
site_description: "Scientifically driven Model-Agnostic Temporal Feature Importance Analysis with SHAP & partitioning algorithms (supporting Pandas, Polars, Modin, PyArrow, Dask)."
copyright: "Copyright © Philip Ndikum, Serge Ndikum, Kane Norman 2024-present"
repo_name: philip-ndikum/TemporalScope
repo_url: https://github.com/philip-ndikum/TemporalScope
nav:
- Home:
- About: index.md
- Getting Started:
- Installation: installation.md
- Quick Start: quick_start.md
- Development:
- Contributing: contributing.md
- Disclaimers:
- License & Legal: license_and_legal.md
- Literature:
- References: references.md
- Cite: citation.md
- API reference: reference/
- Tutorials: tutorials/
theme:
name: "material"
custom_dir: docs/overrides
language: en
favicon: "images/favicon.ico"
icon:
repo: fontawesome/brands/github-alt
font:
text: Roboto
code: Roboto Mono
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.footer
- toc.follow
- navigation.top
- search.suggest
- search.highlight
- search.share
palette:
- media: "(prefers-color-scheme)"
primary: custom
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
toggle:
icon: material/weather-night
name: Switch to system preference
plugins:
- search
- gen-files:
scripts:
- scripts/gen_ref_pages.py
- scripts/gen_tutorial_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
- mkdocstrings:
handlers:
python:
paths: [src]
options:
docstring_options:
ignore_init_summary: true
docstring_style: numpy
summary: true
show_bases: false
annotations_path: brief
docstring_section_style: spacy
merge_init_into_class: true
show_if_no_docstring: true
show_symbol_type_heading: true
show_symbol_type_toc: true
show_labels : false
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
line_length: 60
- mkdocs-jupyter:
execute: true
allow_errors: false
include_requirejs: true
include_source: true
ignore_h1_titles: true
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/philip-ndikum/TemporalScope
name: TemporalScope on GitHub
markdown_extensions:
- def_list
- admonition
- callouts:
strip_period: false
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets
- pymdownx.arithmatex
- pymdownx.emoji
- attr_list
- md_in_html
extra_css:
- css/mkdocstrings.css
- css/colors.css