modern-python-boilerplate/mkdocs.yml at main · lambda-science/modern-python-boilerplate · GitHub

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
site_name: ModernPythonBoilerplate
site_url: https://github.com/lambda-science/modern-python-boilerplate
site_author: Corentin Meyer
site_description: ModernPythonBoilerplate
theme:
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    logo: material/file-document-multiple-outline
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: white
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  name: material
  features:
    - navigation.instant
    - navigation.top
    - navigation.tabs
    - search.suggest
    - search.highlight

plugins:
  - search
  - tags
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [ "src" ]
          options:
            annotations_path: brief
            docstring_style: google
  - include-markdown:
      preserve_includer_indent: true
nav:
  - Home: index.md
  - API Reference: reference.md
markdown_extensions:
  - attr_list
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - tables
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

repo_url: https://github.com/lambda-science/modern-python-boilerplate
extra:
  social:
    - icon: material/web
      link: https://cmeyer.fr/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/corentinm_py