arla/mkdocs.yml at main · renbytes/arla · 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
119
120
121
122
123
124
125
126
# mkdocs.yml

site_name: Affective Reinforcement Learning Agents (ARLA)
site_url: https://renbytes.github.io/arla/
site_description: >-
  ARLA is a framework for building complex, multi-agent simulations
  with a focus on emergent behavior and artificial intelligence.
site_author: Bordumb / Renbytes
repo_url: https://github.com/renbytes/arla
repo_name: arla

docs_dir: docs

# Copyright
copyright: Copyright &copy; 2025 Bordumb / Renbytes

# Configuration
theme:
  name: material
  # logo: assets/logo.svg
  # favicon: assets/favicon.png
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.instant
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

# Plugins
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          setup_paths:
            - agent-core/src
            - agent-engine/src
            - agent-concurrent/src
            - agent-persist/src
            - agent-sim/src
          options:
            show_root_heading: true
            show_source: false
  - blog:
      blog_dir: blog
      authors_file: blog/.authors.yml
  - rss

# Page tree
nav:
  - Home: index.md
  - Tutorials:
    - "Building Your First Simulation": tutorials/first-simulation.md
  - User Guides:
    - "Installation & Setup": guides/installation.md
    - "Running Simulations": guides/running-simulations.md
    - "Understanding the Output": guides/understanding-output.md
  - Developer Guides:
    - "Architecture": architecture/index.md
    - "Creating a New Action": developer/creating-actions.md
    - "Creating a New System": developer/creating-systems.md
    - "The Event Bus": developer/event-bus.md
  - Contributor's Guide:
    - "Development Setup": contributing/setup.md
    - "Coding Standards & Style": contributing/style-guide.md
    - "Running Tests": contributing/testing.md
  - API Reference:
    - "agent-core": api/agent-core.md
    - "agent-engine": api/agent-engine.md
  - Blog: blog/index.md

# Customization
extra:
  blog:
    authors_file: "{blog}/.authors.yml"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/renbytes
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/arla/ # When we publish it

# Markdown extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - attr_list
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra_css:
  - stylesheets/custom.css

extra_javascript:
  - https://unpkg.com/mermaid/dist/mermaid.min.js