-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
95 lines (89 loc) · 2.29 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: VIN
site_description: A Python library for validating and using Vehicle Identification Numbers
site_author: David Peckham
site_url: https://vin.readthedocs.io
repo_name: davidpeckham/vin
repo_url: https://github.com/davidpeckham/vin
copyright: 'Copyright © David Peckham 2024'
# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
docs_dir: docs
site_dir: site
theme:
name: material
language: en
features:
- content.code.copy
- content.tabs.link
- content.tooltips
- navigation.expand
- navigation.footer
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
nav:
- Get Started:
- About: index.md
- API: api.md
- Help: help.md
- Changelog: changelog.md
watch:
- src/vin
plugins:
search: {}
glightbox: {}
minify:
minify_html: true
git-revision-date-localized:
type: date
strict: false
mkdocstrings:
default_handler: python
handlers:
python:
paths: [src]
options:
filters: ["!^_", "^__init__$"]
members_order: source
group_by_category: true
separate_signature: true
show_bases: false
show_category_heading: true
show_if_no_docstring: true
show_root_full_path: false
show_root_heading: true
show_signature_annotations: true
docstring_options:
ignore_init_summary: true
merge_init_into_class: true
mkdocs-simple-hooks:
hooks:
on_pre_build: 'docs.hooks:copy_docs'
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
guess_lang: false
linenums_style: pymdownx-inline
use_pygments: true
- pymdownx.inlinehilite:
- pymdownx.keys:
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shortener: true
social_url_shorthand: true
normalize_issue_symbols: true
provider: github
user: davidpeckham
repo: vin
- pymdownx.mark: