-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathmkdocs.yml
128 lines (122 loc) · 3.42 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
127
128
site_name: "Kasa"
site_description: A Python package with NLP Tools for Low-Resource Languages by GhanaNLP
repo_url: "https://github.com/GhanaNLP/kasa"
repo_name: "GhanaNLP/kasa"
docs_dir: docs/
copyright: Copyright © 2024 GhanaNLP
theme:
name: material
logo: NLPGhana_logo_v2_(black).png
favicon: docs/NLPGhana_logo_v2_(black).png
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.footer
- navigation.sections
- navigation.indexes
- navigation.instant
- navigation.path
- navigation.instant.progress
- navigation.tracking
- search.highlight
- search.suggest
- toc.follow
# - toc.integrate
palette:
- media: "(prefers-color-scheme: light)"
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: teal
accent: lime
toggle:
icon: material/weather-night
name: Switch to system preference
toc_depth: 2
plugins:
- search
- autorefs
- monorepo
- mkdocs-jupyter:
include: ["*.ipynb"]
include_requirejs: true
- mkdocstrings:
handlers:
python:
paths: [khaya]
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
- https://mkdocstrings.github.io/autorefs/objects.inv
- https://mkdocstrings.github.io/griffe/objects.inv
- https://python-markdown.github.io/objects.inv
options:
docstring_options:
ignore_init_summary: false
docstring_section_style: table
heading_level: 2
merge_init_into_class: true
inherited_members: true
members_order: alphabetical
parameter_headings: true
separate_signature: true
show_category_heading: true
show_root_heading: true
show_root_toc_entry: true
show_root_full_path: false
show_signature_annotations: true
show_signature: true
show_source: true
signature_crossrefs: true
summary: true
unwrap_annoated: true
nav:
- Home:
- Overview: index.md
- Changelog: changelog.md
- License: license.md
- Contributing:
- contributing/index.md
- API Reference:
- khaya:
- KhayaInterface:
- api-reference/khaya/khaya_interface.md
markdown_extensions:
- attr_list
- markdown_include.include:
base_path: .
- toc:
toc_depth: 2
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.arithmatex:
generic: true
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra_css:
- stylesheets/extra.css
- stylesheets/mkdocstrings.css
- stylesheets/material.css
extra:
version: 0.4.0