-
Notifications
You must be signed in to change notification settings - Fork 11
/
mkdocs.yml
72 lines (66 loc) · 1.89 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
site_name: pydantic-yaml
repo_name: NowanIlfideme/pydantic-yaml
repo_url: https://github.com/NowanIlfideme/pydantic-yaml/
site_author: Anatoly Makarevich
site_description: YAML support for Pydantic models
# NOTE: This allows looking at docs locally
# See https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
site_url: ""
use_directory_urls: false
nav:
- Overview: index.md
- Install: installing.md
- Deprecated:
- Versioned Models: versioned.md
theme:
name: "material"
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: pink
accent: pink
toggle:
icon: material/lightbulb
name: Switch to light mode
# Plugins: https://squidfunk.github.io/mkdocs-material/reference/code-blocks/
plugins:
- search
- autorefs
- mkdocstrings:
handlers:
python:
rendering:
docstring_style: numpy
show_root_heading: true
show_object_full_path: false
show_signature_annotations: true
selection:
filters:
- "^__init__$" # but always include __init__ modules and methods
- "!^_" # exlude all members starting with _
markdown_extensions:
# - markdown_include.include:
# base_path: docs
# - toc:
# permalink: "🔗"
- toc:
permalink: True
- pymdownx.highlight:
use_pygments: true
linenums: true
- pymdownx.superfences
- pymdownx.inlinehilite
# - pymdownx.emoji:
# emoji_index: !!python/name:pymdownx.emoji.gemoji
# emoji_generator: !!python/name:pymdownx.emoji.to_svg
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/NowanIlfideme/pydantic-yaml/