mkdocs.yml

# mkdocs.yml
site_name: "HamilFlow"
site_author: ""
site_description: "Dataset of simple physical systems."
site_url: "https://kausalflow.github.io/hamilflow"
repo_url: "https://github.com/kausalflow/hamilflow"
edit_uri: "blob/main/docs/"
repo_name: "kausalflow/hamilflow"


theme:
  name: "material"
  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    # - navigation.instant
    - navigation.sections
    - navigation.tabs
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  # favicon: assets/logo.png
  # logo: assets/logo_transparent.png



markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist
  - pymdownx.arithmatex:
      generic: true
  - toc:
      permalink: "¤"

plugins:
  - autorefs
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: sphinx
            filters:
  - mkdocs-jupyter:
      execute: True
      allow_errors: false
      include_requirejs: true

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - "Home": index.md
  - "Tutorials":
    - "Introduction": tutorials/index.md
    - "Harmonic Oscillator": tutorials/harmonic_oscillator.py
    - "Complex Harmonic Oscillator": tutorials/complex_harmonic_oscillator.py
    - "Brownian Motion": tutorials/brownian_motion.py
    - "Pendulum": tutorials/pendulum.py
    - "Kepler Problem": tutorials/kepler_problem.py
    - "Harmonic Oscillator Chain": tutorials/harmonic_oscillator_chain.py
  - References:
    - "Introduction": references/index.md
    - "Models":
      - "Harmonic Oscillator": references/models/harmonic_oscillator.md
      - "Brownian Motion": references/models/brownian_motion.md
      - "Pendulum": references/models/pendulum.md
      - Kepler Problem:
        - Model: references/models/kepler_problem/model.md
        - Dynamics: references/models/kepler_problem/dynamics.md
        - Numerics: references/models/kepler_problem/numerics.md
      - "Harmonic Oscillator Chain": references/models/harmonic_oscillator_chain.md
    - Mathematics:
      - Trigonometrics: references/maths/trigonometrics.md
  - "Changelog": changelog.md