micromotion/mkdocs.yml at main · fourMs/micromotion · 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
site_name: micromotion
site_description: Micromotion analysis of motion time series — mocap, IMU and force plate
repo_url: https://github.com/fourMs/micromotion
repo_name: fourMs/micromotion
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle: { icon: material/weather-night, name: Dark mode }
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle: { icon: material/weather-sunny, name: Light mode }

# Ordered overarching-first, then progressively more detail. `conventions.md` sits
# second because the README calls it the one convention that cannot be skipped, and the
# nav used to contradict the README by putting the 684-line methods reference there
# instead. A reference is what you consult; it is not what you read second.
nav:
  - Home: index.md
  - Getting started: quickstart.md
  - The three bands: conventions.md
  - Working with your data:
      - Reading files: formats.md
      - Sampling rates: rates.md
      - Validating data: validation.md
  - Going further:
      - One feature vector: features.md
      - Stating a null: nulls.md
      - Working with other packages: interop.md
  - Methods and references: methods.md
  - API reference: api.md

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            # Types live in the docstrings, not in signature annotations;
            # griffe 2.x would otherwise warn (fatal under --strict).
            docstring_options:
              warn_missing_types: false
            show_source: true
            show_root_heading: true
            heading_level: 3
            members_order: source
            separate_signature: true
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - tables
  - toc: { permalink: true }