-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
113 lines (107 loc) · 2.91 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
# This file was generated from scaffops/[email protected].
# Instead of changing this particular file, you might want to alter the template:
# https://github.com/scaffops/python/tree/0.0.2rc-238-g68b0ab8/project/%23%25%20if%20docs%20%25%23mkdocs.yml%23%25%20endif%20%25%23.jinja
site_name: "slothy"
site_description: "Super-easy lazy importing in Python."
site_url: "https://bswck.github.io/en/latest/"
repo_name: "bswck/slothy"
repo_url: "https://github.com/bswck/slothy"
edit_uri: "edit/main/docs/"
watch:
- "slothy"
nav:
- "Overview": "index.md"
- "Why <i>slothy</i>?": "why_slothy.md"
- "Installation": "installation.md"
- "Tutorial": "tutorial.md"
- "Guidelines": "guidelines.md"
- "How It Works": "how_it_works.md"
- "API Reference": "api.md"
- "Contributing": "contributing.md"
- "Code of Conduct": "code_of_conduct.md"
- "Changelog": "changelog.md"
theme:
name: "material"
features:
- "announce.dismiss"
- "header.autohide"
- "content.action.edit"
- "content.action.view"
- "content.code.annotate"
- "content.code.copy"
- "content.tabs.link"
- "content.tooltips"
- "navigation.footer"
- "navigation.indexes"
- "navigation.sections"
- "navigation.top"
- "navigation.tracking"
- "search.highlight"
- "search.suggest"
- "toc.follow"
palette:
- media: "(prefers-color-scheme: light)"
scheme: "default"
primary: "teal"
accent: "amber"
toggle:
icon: "material/lightbulb"
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: "slate"
primary: "teal"
accent: "amber"
toggle:
icon: "material/lightbulb-outline"
name: "Switch to light mode"
extra_css:
- "css/mkdocstrings.css"
markdown_extensions:
- "admonition"
- "footnotes"
- "pymdownx.emoji"
- "codehilite"
- "pymdownx.magiclink"
- "pymdownx.superfences"
- "md_in_html"
- mdx_include:
base_path: "docs/"
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
use_pygments: true
- toc:
permalink: true
plugins:
# - "mike"
# - "git-authors"
- "search"
- "autorefs"
- "markdown-exec"
- mkdocstrings:
handlers:
python:
options:
show_root_heading: true
heading_level: 3
# https://mkdocstrings.github.io/python/usage/#configuration/
docstring_style: "numpy"
docstring_section_style: "list"
docstring_options:
ignore_init_summary: true
trim_doctest_flags: false
members_order: "source"
merge_init_into_class: true
parameter_headings: true
show_submodules: true
show_inheritance_diagram: false
show_signature_annotations: false
signature_crossrefs: true
line_length: 60
show_labels: false
show_symbol_type_heading: false
show_symbol_type_toc: true
summary: true
paths: ["slothy/"]
import:
- "https://docs.python.org/3/objects.inv"