GRL/mkdocs.yml at main · pleiadian53/GRL · 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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
site_name: Generalized Reinforcement Learning (GRL)
site_description: Physics-grounded reinforcement learning with particle-based belief representations
site_author: GRL Research Team
site_url: https://pleiadian53.github.io/GRL/
# Note: For local development, MkDocs ignores site_url and serves at http://127.0.0.1:8000/

repo_name: pleiadian53/GRL
repo_url: https://github.com/pleiadian53/GRL
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2026 GRL Research Team

# Theme configuration
theme:
  name: material
  language: en
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant        # Instant loading
    - navigation.tracking       # Anchor tracking
    - navigation.tabs           # Top-level navigation tabs
    - navigation.tabs.sticky    # Sticky tabs
    - navigation.sections       # Section navigation
    - navigation.expand         # Expand sections by default
    - navigation.top            # Back to top button
    - search.suggest            # Search suggestions
    - search.highlight          # Highlight search results
    - content.code.copy         # Copy button for code blocks
    - content.action.edit       # Edit button (links to GitHub)
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3

  # Python Markdown Extensions (pymdownx)
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra JavaScript for MathJax
# (polyfill.io removed — that domain was compromised in 2024 and served malware;
#  MathJax 3 needs no polyfill on modern browsers, so math still renders as before.)
extra_javascript:
  - javascripts/mathjax.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Extra CSS
extra_css:
  - stylesheets/extra.css

# Plugins
plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
  - tags
  - mkdocs-jupyter:
      include_source: True           # Include source code in rendered output
      execute: False                 # Don't re-run notebooks (use saved outputs)
      allow_errors: False            # Stop build if notebook has errors
      ignore_h1_titles: True         # Use filename as title, not first H1
      theme: light                   # Code theme (light for better readability)
      remove_tag_config:
        remove_input_tags:
          - hide_input

# Navigation structure
nav:
  - Home: index.md
  - 'GRL v0 (Tutorial Paper)':
      - Overview: GRL0/README.md
      - 'Part I: Tutorials':
          - 'Tutorial Index': GRL0/tutorials/README.md
          - 'Ch 0: Overview': GRL0/tutorials/00-overview.md
          - 'Ch 1: Core Concepts': GRL0/tutorials/01-core-concepts.md
          - 'Ch 2: RKHS Foundations': GRL0/tutorials/02-rkhs-foundations.md
          - 'Ch 3: Energy and Fitness': GRL0/tutorials/03-energy-and-fitness.md
          - 'Ch 3a: Least Action Principle': GRL0/tutorials/03a-least-action-principle.md
          - 'Ch 4: Reinforcement Field': GRL0/tutorials/04-reinforcement-field.md
          - 'Ch 4a: Riesz Representer': GRL0/tutorials/04a-riesz-representer.md
          - 'Ch 5: Particle Memory': GRL0/tutorials/05-particle-memory.md
          - 'Ch 6: MemoryUpdate': GRL0/tutorials/06-memory-update.md
          - 'Ch 6a: Advanced Memory Dynamics': GRL0/tutorials/06a-advanced-memory-dynamics.md
          - 'Ch 7: RF-SARSA': GRL0/tutorials/07-rf-sarsa.md
          - 'Ch 7a: Continuous Policy Inference': GRL0/tutorials/07a-continuous-policy-inference.md
      - 'Quantum-Inspired Extensions':
          - 'Overview': GRL0/quantum_inspired/README.md
          - '01: RKHS-QM Parallel': GRL0/quantum_inspired/01-rkhs-quantum-parallel.md
          - '01a: Wavefunction Interpretation': GRL0/quantum_inspired/01a-wavefunction-interpretation.md
          - '02: Basis and Amplitudes': GRL0/quantum_inspired/02-rkhs-basis-and-amplitudes.md
          - '03: Complex RKHS': GRL0/quantum_inspired/03-complex-rkhs.md
          - '04: Action and State Fields': GRL0/quantum_inspired/04-action-and-state-fields.md
          - '05: Concept Projections': GRL0/quantum_inspired/05-concept-projections-and-measurements.md
          - '06: Agent State and Belief': GRL0/quantum_inspired/06-agent-state-and-belief-evolution.md
          - '07: Learning Beyond GP': GRL0/quantum_inspired/07-learning-the-field-beyond-gp.md
          - '08: Memory Dynamics': GRL0/quantum_inspired/08-memory-dynamics-formation-consolidation-retrieval.md
          - '09: Path Integrals': GRL0/quantum_inspired/09-path-integrals-and-action-principles.md
      - 'Implementation Guide': GRL0/implementation/README.md
      - 'Recovering Classical RL': GRL0/recovering_classical_rl.md
  - 'Research Roadmap': ROADMAP.md
  - 'Notebooks':
      - 'Overview': notebooks/README.md
      - 'Field Series':
          - 'Series Overview': notebooks/field_series/README.md
          - 'Roadmap': notebooks/field_series/ROADMAP.md
          - '00: Introduction to Vector Fields': notebooks/field_series/00_intro_vector_fields.ipynb
          - '01: Classical Vector Fields': notebooks/field_series/01_classical_vector_fields.ipynb
          - '01a: Vector Fields and ODEs': notebooks/field_series/01a_vector_fields_and_odes.ipynb
          - '02: Functional Fields': notebooks/field_series/02_functional_fields.ipynb
          - 'Reinforcement Fields':
              - 'Overview': notebooks/field_series/03_reinforcement_fields/README.md
              - '03: Reinforcement Fields': notebooks/field_series/03_reinforcement_fields/03_reinforcement_fields.ipynb
              - '03a: Particle Coverage Effects': notebooks/field_series/03_reinforcement_fields/03a_particle_coverage_effects.ipynb
              - 'Theory: Particle vs Gradient Fields': notebooks/field_series/03_reinforcement_fields/particle_vs_gradient_fields.md
  - 'About':
      - 'Contributing': CONTRIBUTING.md
      - 'License': LICENSE.md

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/pleiadian53/GRL
  version:
    provider: mike