-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
97 lines (88 loc) · 2.21 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
site_name: taskade
site_url:
site_dir: docs
site_description: A simple and beautiful theme for MkDocs.
site_author: Alexander Epstein
repo_name: taskade
repo_url: https://github.com/alexanderepstein/taskade
nav:
- Home:
- Introduction: index.md
- Quick Start: quick_start.md
- CGraphlib: cgraphlib.md
- Changelog: changelog.md
- License: license.md
- Usage:
- usage/index.md
- Advanced Usage: usage/advanced_usage.md
- Development:
- development/index.md
- Coverage Report: coverage_report.md
- Code Reference: reference/
theme:
name: material
logo: assets/logo_blue.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: red
toggle:
icon: material/weather-night
title: Switch to Dark Mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: red
toggle:
icon: material/weather-sunny
title: Switch to Light Mode
features:
- content.tabs.link
- navigation.tabs
- navigation.tabs.sticky
- navigation.tabs.scrollspy
- nagivation.path
- navigation.prev_next
- navigation.prev_next.sticky
- navigation.tracking
plugins:
- autorefs
- search
- git-authors
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- git-revision-date-localized:
format: "%Y-%m-%d %H:%M:%S"
- mkdocstrings:
enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
default_handler: python
handlers:
python:
paths: [src]
import:
- url: https://docs.python.org/objects.inv
domains: [std, py]
options:
docstring_style: sphinx
show_source: true
show_type_annotations: true
- coverage:
page_name: coverage_report
html_report_dir: docs/development/coverage
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.emoji
- pymdownx.magiclink
- pymdownx.highlight:
use_pygments: true
pygments_lang_class: true
- pymdownx.snippets:
base_path: docs