PyreWire/mkdocs.yml at main · semantic-reasoning/PyreWire · 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
site_name: PyreWire
site_description: Python bindings for the wirelog declarative dataflow engine
site_url: https://semantic-reasoning.github.io/PyreWire/
repo_url: https://github.com/semantic-reasoning/PyreWire
repo_name: semantic-reasoning/PyreWire
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - toc.integrate
  palette:
    - scheme: default
      primary: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

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

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Support: support.md
  - Versioning: versioning.md
  - API stability: api-stability.md
  - Release candidate checklist: release-candidate-checklist.md
  - Semantics:
      - Z-set & retraction: semantics/zset.md
      - Step vs snapshot: semantics/step-vs-snapshot.md
      - Compounds: semantics/compounds.md
      - Threading: semantics/threading.md
  - Reference:
      - Sessions: reference/sessions.md
      - Async sessions: reference/async.md
      - Program & schema: reference/program.md
      - Batch & result: reference/batch.md
      - Compounds: reference/compounds.md
      - IR inspection: reference/ir.md
      - IO adapters: reference/io.md
      - Errors: reference/errors.md