auditable/mkdocs.yml at main · yzhao062/auditable · 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
83
84
85
86
87
88
89
90
91
site_name: auditable
site_description: "An open-source system of record for AI-agent decisions: it captures what each decision relied on, replays it against live state, and rolls back the committed action when it no longer holds."
site_url: https://auditable-ai.readthedocs.io/
site_author: Yue Zhao
repo_url: https://github.com/yzhao062/auditable
repo_name: yzhao062/auditable
edit_uri: edit/main/docs/
docs_dir: docs

theme:
  name: material
  logo: assets/auditable-mark.svg
  favicon: assets/favicon.ico
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.action.edit
    - search.highlight
    - search.suggest
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_root_heading: true
            show_source: false
            heading_level: 2
            members_order: source
            docstring_section_style: list
            separate_signature: true
            filters: ["!^_", "!^fit$"]

nav:
  - Home: index.md
  - Lifecycle: lifecycle.md
  - Quickstart: quickstart.md
  - PRE: pre-rules.md
  - LIVE: realtime-replay.md
  - POST: post-analysis.md
  - Examples:
      - PRE Examples: pre-examples.md
      - LIVE Examples: realtime-examples.md
      - POST Examples: post-examples.md
  - Reference:
      - PRE Coverage: pre-coverage.md
      - Audit Report: audit-report.md
      - Data Module: data-module.md
      - Architecture: architecture.md
      - API Reference: api.md