DemocracySim/mkdocs.yml at main · jurikane/DemocracySim · 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
127
128
129
130
# Project information
site_name: DemocracySim
site_description: <b>Mesa-based simulation platform for voting rules, participation, and inequality dynamics.</b>
site_url: https://jurikane.github.io/DemocracySim/
site_author: Paul Kühnel
exclude_docs: |
  internal/**

# Repository
repo_url: https://github.com/jurikane/DemocracySim
edit_uri: edit/main/docs/

# Configuration
nav:
    - Home: index.md
    - Teaser: teaser.md
    - Research:
        - Thesis Contract: research/thesis_contract.md
        - Thesis Model Concepts: research/thesis_model_concepts.md
        - Concept Deep Dives:
            - Grid State Concept: research/grid_state_concept.md
            - Puzzle Quality Gate Concept: research/puzzle_quality_gate_concept.md
            - Satisfaction to Altruistic Voting: research/satisfaction_altruistic_voting_concept.md
            - Participation Dilemma and Group Learning: research/participation_dilemma_and_group_learning_concept.md
            - Dynamics and Rule Interaction: research/dynamics_rule_interaction_concept.md
        - Thesis Measurement Spec: research/thesis_measurement_spec.md
        - Metric Glossary: research/metric_glossary.md
    - Technical:
        - Overview: technical/technical_overview.md
        - Demo: technical/demo.md
        - Semantics, Representations & RNG: technical/semantics_representation_rng.md
        - Voting Rules: technical/voting_rules.md
        - Core Mechanics (Fees/Rewards/Distance): technical/core_mechanics.md
        - Environment Dynamics: technical/environment_dynamics.md
        - Structural Topology: technical/structural_topology.md
        - Population & Preferences: technical/population_preferences.md
        - Run Control & Output: technical/run_control_output.md
        - Learning:
            - Participation Learning: technical/participation_learning.md
            - Altruism Voting Behavior: technical/altruism_learning.md
        #- Installation Instructions: technical/installation_instructions.md
        - API Reference:
            - Model (Environment): technical/api/Model.md
            - Area (Territory): technical/api/Area.md
            - Grid Cell: technical/api/ColorCell.md
            - Voting Agent: technical/api/VoteAgent.md
            - Strategies: technical/api/Strategies.md
            - Inherited Classes: technical/api/inherited.md
            - Utility Functions: technical/api/utility_functions.md
            - Output Schema V3: technical/api/output_schema_v3.md
        #- User Guide: technical/user_guide.md #1. Provide step-by-step guides for common project usage.
        #- Examples: technical/examples.md #1. Show key use cases via practical code examples or interactive demos.
        #- Developer Docs: technical/dev_docs.md #Offer guidelines for contributing or extending the project (e.g., folder structure, conventions, CI/CD pipelines).
        #- Architecture Overview: technical/architecture_overview.md
    #- Overview: overview.md
    #- Code: the_voting_process_step_by_step.md
    - Mesa: mesa_docs.md

theme:
  name: material
  custom_dir: 'docs/overrides'
  icon:
    repo: octicons/mark-github-16
    edit: material/pencil
    view: material/eye
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-3
        name: Switch to system preference
  features:
    - navigation.expand
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - toc.follow
    - toc.integrate
    - search.share
    - search.highlight
    - search.suggest
    - content.action.edit
# Plugins
plugins:
  - i18n:
      docs_structure: folder
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: de
          name: Deutsch
          build: true
  - autorefs:
      resolve_closest: true
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_private_members: true

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.arithmatex
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format