microbench/mkdocs.yml at main · alubbock/microbench · 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
site_name: microbench
site_description: Micro-benchmarking and reproducibility metadata capture for Python
site_url: https://alubbock.github.io/microbench/
repo_url: https://github.com/alubbock/microbench
repo_name: alubbock/microbench

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.sections
    - navigation.top
    - toc.follow
    - content.code.copy

markdown_extensions:
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - admonition
  - tables

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_if_no_docstring: false
            show_attribute_values: true
            filters:
              - "!^_"
  - mike:
      alias_type: symlink
      canonical_version: latest

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Command-line interface: cli.md
  - User guide:
    - Python API configuration: user-guide/configuration.md
    - Mixins: user-guide/mixins.md
    - Output: user-guide/output.md
    - Periodic monitoring: user-guide/monitoring.md
    - Async functions: user-guide/async.md
    - Extending microbench: user-guide/extending.md
    - Advanced usage: user-guide/advanced.md
  - API reference: api-reference.md
  - Citing microbench: citing.md
  - Changelog: changelog.md