python_with_doc_template/mkdocs.yml at main · Cosmo-Tech/python_with_doc_template · 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
site_name: Doc template
repo_url: https://github.com/Cosmo-Tech/python_with_doc_template
repo_name: Cosmo-Tech/python_with_doc_template
site_description: Simple documentation template for Cosmo Tech python projects

theme:
  name: material
  logo: assets/logo.png
  font:
    code: Fira Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.instant
    - navigation.footer
  custom_dir: overrides
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike

nav:
  - Home: 'index.md'
  - Getting started:
    - Dependencies: 'dependencies.md'
  - References: references/

markdown_extensions:
    - admonition
    - attr_list
    - footnotes
    - md_in_html
    - tables
    - toc:
        title: "In this page"
        permalink: true
    - def_list
    - pymdownx.details
    - pymdownx.snippets:
        url_download: true
    - pymdownx.superfences
    - pymdownx.highlight
    - pymdownx.inlinehilite
    - pymdownx.critic
    - pymdownx.caret
    - pymdownx.keys
    - pymdownx.mark
    - pymdownx.tilde
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
    - search
    - mkdocstrings:
        default_handler: python
        handlers:
          python:
            options:
              docstring_style: sphinx
              line_lenth: 120
    - gen-files:
        scripts:
          - scripts/generate_references.py
          - scripts/generate_dependencies_markdown.py
          - scripts/generate_index.py
    - literate-nav
    - mike
    - social