iolaus/mkdocs.yml at main · vgreg/iolaus · 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
site_name: Iolaus
site_description: Decorator-based CLI, config, and logging framework for research projects.
site_url: https://www.vincentgregoire.com/iolaus/
repo_url: https://github.com/vgreg/iolaus
repo_name: vgreg/iolaus

theme:
  name: material
  logo: assets/iolaus.webp
  favicon: assets/iolaus.webp
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Light mode
  features:
    - navigation.tabs
    - navigation.sections
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Configuration: configuration.md
  - CLI: cli.md
  - API Reference: api-reference.md

markdown_extensions:
  - tables
  - pymdownx.highlight
  - pymdownx.superfences
  - admonition
  - pymdownx.details