maya-python-project-template/mkdocs.yml at main · matthewlee-dev/maya-python-project-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
site_name: Maya Python Project Template
repo_url: https://github.com/matthewlee-dev/maya-python-project-template
repo_name: matthewlee-dev/maya-python-project-template
theme:
  name: material
  language: en
  # Setup swaps this file for the generated project's logo, so the path holds
  # for both.
  logo: resources/images/maya_python_logo.png
  favicon: resources/images/maya_python_logo.png
  palette:
    - scheme: slate
      primary: black
      accent: teal

plugins:
- search:
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        # Docs CI syncs only the docs group, so the project isn't installed.
        paths: [src]
        options:
          show_source: true

watch:
  - src

nav:
  - index.md
  - getting-started.md
  - project-layout.md
  - writing-your-tool.md
  - testing.md
  - ci.md
  - releasing.md
  - documentation.md
  - reference.md