spine-lite-python/mkdocs.yml at main · MacFall7/spine-lite-python · 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
78
79
80
81
82
site_name: spine-lite
site_description: Deterministic policy and effects runtime for LLM tool calls.
site_url: https://macfall7.github.io/spine-lite-python/
repo_url: https://github.com/MacFall7/spine-lite-python
repo_name: MacFall7/spine-lite-python
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      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
            separate_signature: true
            show_signature_annotations: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Concepts:
      - Overview: concepts/overview.md
      - Effects Taxonomy: concepts/effects-taxonomy.md
      - Posture and Hooks: concepts/posture-and-hooks.md
  - How-To:
      - Use the API: how-to/use-the-api.md
      - Wire into Claude Code: how-to/wire-claude-code.md
      - Contribute: how-to/contribute.md
      - Release: how-to/release.md
  - Reference:
      - API: reference/api.md
      - CLI: reference/cli.md
      - Exceptions: reference/exceptions.md
      - Glossary: reference/glossary.md
  - Explanation:
      - Architecture: explanation/architecture.md
      - Invariants: explanation/invariants.md
      - Design Rationale: explanation/design-rationale.md
      - Porting Notes: explanation/porting-notes.md
      - FAQ: explanation/faq.md
  - History:
      - Phase 1: history/phase-1.md
      - Phase 2: history/phase-2.md
      - Phase 3: history/phase-3.md

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true