-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs.yml
70 lines (70 loc) · 1.97 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
# Set strict to true to turn warnings into errors to catch warnings within CI.
strict: true
theme:
name: material
# By default, fonts are pulled from Google on the Internet. To support offline usage, this is
# disabled.
font: false
palette:
scheme: slate
primary: green
accent: yellow
icon:
# GitHub specific.
repo: fontawesome/brands/github
# favicon:
features:
- content.code.annotate
- navigation.tracking
- search.highlight
- search.share
- search.suggest
markdown_extensions:
- admonition
- pymdownx.keys
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
- md_in_html
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/rbaltrusch/desktop_shop
# This is needed to allow links to work when opened from the file system.
use_directory_urls: false
plugins:
- search
- mkdocstrings:
handlers:
python:
rendering:
show_if_no_docstring: true
show_signature_annotations: true
watch:
- desktop_shop
# Autodoc configuration.
# https://mkdocstrings.github.io/recipes/#automatic-code-reference-pages
- gen-files:
scripts:
- doc/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
# This plugin is used to validate URLs (including some anchors).
# Uncomment to build the docs with this validation enabled.
# This is commented out by default because this requires network I/O to validate URLs, so it is
# inherently not exactly reproducible. But this plugin is none-the-less helpful at detecting
# incorrect URLs.
# - htmlproofer:
# raise_error: True
site_name: desktop_shop
copyright: Copyright © 2020-2022 Richard Baltrusch
# GitHub Specific Configuration.
repo_name: desktop_shop
repo_url: https://github.com/rbaltrusch/desktop_shop
edit_uri: edit/master/doc/user_guide/docs/
docs_dir: doc
nav:
- index.md
- Code Reference: reference/