stateless-py/mkdocs.yml at main · alti3/stateless-py · 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
site_name: Stateless-py
site_description: A Python library for building strongly-typed, fluent state machines
repo_url: https://github.com/alti3/stateless-py
repo_name: alti3/stateless-py

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - Guide:
      - Core Concepts: guide/core-concepts.md
      - Configuration: guide/configuration.md
      - Guards: guide/guards.md
      - Actions: guide/actions.md
      - Async and Firing Modes: guide/async.md
      - Hierarchical States: guide/hierarchy.md
      - Advanced Transitions: guide/advanced-transitions.md
      - Triggering and Queries: guide/triggering-and-queries.md
      - External State Storage: guide/external-state.md
  - Introspection:
      - Overview: introspection/overview.md
      - Graphs: introspection/graphs.md
  - Examples:
      - Overview: examples/index.md
      - 01 Simple Phone Call: examples/01-simple-phone-call.md
      - 02 Bug Tracker: examples/02-bug-tracker.md
      - 03 Async Actions: examples/03-async-actions.md
      - 04 Ignore and Reentry: examples/04-ignore-reentry.md
      - 05 On Off Toggle: examples/05-on-off.md
      - 06 Alarm Asyncio Workflow: examples/06-alarm-asyncio.md
      - 07 JSON Serialization: examples/07-json-serialization.md
      - 08 Advanced Features: examples/08-advanced-features.md
  - API Reference:
      - Overview: reference/index.md
      - StateMachine: reference/state-machine.md
      - StateConfiguration: reference/state-configuration.md
      - Transition Model: reference/transition.md
      - Reflection Models: reference/reflection-models.md
      - Errors and Firing Modes: reference/errors-and-modes.md
  - Architecture: architecture.md
  - C# Parity: parity.md
  - Development: development.md

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

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: false