PyroSense-Simulator/mkdocs.yml at main · jssutachan/PyroSense-Simulator · 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
site_name: PyroSense Simulator
site_description: PyroSense simulation subsystem — early wildfire detection
repo_url: https://github.com/jssutachan/PyroSense-Simulator
repo_name: jssutachan/PyroSense-Simulator

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: deep orange
      toggle:
        icon: material/weather-night
        name: Dark mode
    - scheme: slate
      primary: deep orange
      toggle:
        icon: material/weather-sunny
        name: Light mode
  features:
    - navigation.sections
    - content.code.copy

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

markdown_extensions:
  - admonition
  - tables
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Data contract: data-contract.md
  - API reference: reference.md
  - Decisions (ADRs):
      - Index: adr/index.md
      - ADR-0001 Two programs: adr/ADR-0001-two-programs.md
      - ADR-0002 Contract first: adr/ADR-0002-contract-first.md
      - ADR-0003 Pydantic at the boundary: adr/ADR-0003-pydantic-at-the-boundary.md
      - ADR-0004 Simplified Git Flow: adr/ADR-0004-git-flow.md
      - ADR-0005 Health, not alerts: adr/ADR-0005-device-health-not-alerts.md
      - ADR-0006 Tooling (uv + src layout): adr/ADR-0006-tooling.md
      - ADR-0007 Deterministic plan: adr/ADR-0007-deterministic-plan.md
      - ADR-0008 Gateways as metadata: adr/ADR-0008-gateways-as-metadata.md
      - ADR-0009 Noise lives in the sensor: adr/ADR-0009-noise-lives-in-the-sensor.md
      - ADR-0010 stdout as data channel: adr/ADR-0010-stdout-data-channel.md
      - ADR-0011 Parametric fire: adr/ADR-0011-parametric-fire.md
      - ADR-0012 Faults as decorator: adr/ADR-0012-faults-as-decorator.md
      - ADR-0013 QoS 1, dedupe in the cloud: adr/ADR-0013-qos1-dedupe-in-the-cloud.md
  - Testing strategy: testing-strategy.md
  - Contributing: CONTRIBUTING.md
  - Best-practices review: best-practices-review.md