forked from Mrldatalab/datalab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
100 lines (89 loc) · 2.3 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
site_name: datalab
site_description: Documentation for datalab
site_url: https://the-datalab.readthedocs.io
theme:
name: material
icon:
repo: fontawesome/brands/github
language: en
palette:
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: amber
accent: brown
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to light mode
primary: amber
accent: brown
font:
text: Figtree
code: Iosevka Web
features:
- content.code.copy
repo_name: datalab-org/datalab
repo_url: https://github.com/datalab-org/datalab
docs_dir: "pydatalab/docs"
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/datalab-org
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.highlight
- pymdownx.superfences:
# Allows mermaid code blocks to be rendered via mermaid.js
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite
- pymdownx.tabbed
- pymdownx.tasklist
- pymdownx.snippets
- toc:
permalink: true
extra_css:
- css/reference.css
plugins:
- mkdocstrings:
default_handler: python
handlers:
python:
options:
show_root_heading: true
show_root_toc_entry: true
show_root_full_path: true
show_object_full_path: false
show_category_heading: false
show_if_no_docstring: true
show_signature_annotations: true
show_source: true
show_bases: true
group_by_category: true
heading_level: 2
members_order: "source"
members: true
inherited_members: true
docstring_style: google
enable_inventory: true
filters:
- "!^_[^_]"
- "!__json_encoder__$"
- "!__all__$"
- "!__config__$"
- "!^Config$"
- awesome-pages
- autorefs
- search:
lang: en
watch:
- pydatalab