-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
95 lines (88 loc) · 2.4 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
site_name: PyMesh Docs
repo_url: https://github.com/tviuff/pymesh
site_url: https://tviuff.github.io/pymesh
theme:
name: material
language: en
features:
- navigation.tabs
- navigation.top
# - navigation.indexes # ! conflicts with the section-index plugin for auto-generated docs
- content.code.copy
- content.code.select
- content.code.annotate
icon:
repo: fontawesome/brands/github
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: amber
toggle:
icon: material/lightbulb
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: amber
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
extra:
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
plugins:
- search
- gen-files:
scripts:
- docs/gen_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index # allows clickable sections that lead to an index page
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [.]
options:
members_order: source
separate_signature: true
# filters: ["!^_"] # removes magic methods
docstring_options:
ignore_init_summary: false
merge_init_into_class: false
markdown_extensions:
- admonition
- attr_list
- footnotes
- pymdownx.arithmatex:
generic: true
- pymdownx.highlight:
use_pygments: true
auto_title: false
linenums: true
linenums_style: pymdownx-inline
anchor_linenums: true
line_spans: __span
- pymdownx.inlinehilite
- pymdownx.details
- pymdownx.mark
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- toc:
permalink: "#"