site/mkdocs.yml at main · structural-explainability/site · 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# mkdocs.yml
# Configuration file for MkDocs (Automated project documentation generator)

site_name: structural-explainability
site_url: https://structural-explainability.github.io/site/
repo_url: https://github.com/structural-explainability/site
site_description: Organization website.
site_author: structural-explainability
docs_dir: docs
site_dir: site
copyright: Copyright &copy; 2025 Denise M. Case
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/structural-explainability/site
  languages:
    - name: English
      code: en
      default: true
    - name: Français
      code: fr
    - name: Ελληνικά
      code: el

theme:
  name: material
  features:
    - navigation.expand
    - navigation.sections # Group navigation items
    - navigation.top # Back-to-top button
    - search.suggest # Search suggestions while typing
    - search.highlight # Highlight search terms
    - content.code.copy # Copy button on code blocks
    - toc.follow # Highlight current section in TOC

  palette:
    - scheme: default # Light/dark mode toggle
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src/python/src
          options:
            show_source: true
            show_root_heading: true # Include module names
            show_root_toc_entry: true # Include module in TOC
            docstring_style: google # Professional docstring format
            show_signature_annotations: true
            separate_signature: true # Makes function signatures easier to read
  - i18n:
      languages:
        - locale: en
          name: English
          default: true
          build: true
        - locale: fr
          name: Français
          build: false
        - locale: el
          name: Ελληνικά
          build: false

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/ajv/8.17.1/ajv2020.bundle.js
  - js/validator.js

markdown_extensions:
  - admonition # Note/Warning/Tip boxes
  - codehilite # Syntax highlighting
  - tables # Markdown tables
  - toc:
      permalink: true # Clickable headers
      toc_depth: 3
  - pymdownx.superfences # Code blocks with syntax highlighting
  - pymdownx.details # Collapsible sections
  - pymdownx.inlinehilite # Inline code highlighting
  - pymdownx.snippets # Include external files
  - pymdownx.tabbed # Tabbed content

nav:
  - Site: index.md

  - Home: en/index.md
  - Overview: en/overview.md

  - Results:
      - Neutral Substrate (P100): en/results/p100-neutral-substrate.md
      - Identity Regimes (P200): en/results/p200-identity-regimes.md

  - Constructions:
      - Accountable Entities (AE): en/constructions/accountable-entities.md
      - Evolution Protocol (EP): en/constructions/evolution-protocol.md
      - Contextual Evidence & Explanations (CEE): en/constructions/cee.md
      - Interpretation Boundary: en/constructions/interpretation-boundary.md

  - Adoption:
      - For implementers: en/adoption/implementers.md
      - Standards mapping: en/adoption/standards-mapping.md
      - FAQ: en/adoption/faq.md

  - Governance:
      - Annotation Standard: en/governance/annotations.md
      - Licensing and citation: en/governance/licensing-and-citation.md