mkdocs.yml

site_name: Spyral
site_url: https://example.com/
repo_url: https://github.com/ATTPC/Spyral/
site_description: Documentation for the Spyral AT-TPC analysis framework
site_author: Gordon McCann

nav:
  - Home: index.md
  - User Guide:
    - Setup and Installation: user_guide/setup.md
    - Getting Started: user_guide/getting_started.md
    - Configuration:
      - About Configurations: user_guide/config/about.md
      - Pad Plane: user_guide/config/pad.md
      - Detector: user_guide/config/detector.md
      - GET & FRIB Traces: user_guide/config/traces.md
      - Cluster: user_guide/config/cluster.md
      - Estimate: user_guide/config/estimate.md
      - Solver: user_guide/config/solver.md
    - Analysis Phases:
      - About Phases: user_guide/phases/about.md
      - Point Cloud: user_guide/phases/point_cloud.md
      - Cluster: user_guide/phases/cluster.md
      - Estimate: user_guide/phases/estimate.md
      - Solve: user_guide/phases/solve.md
    - Numba: user_guide/numba.md
    - Parallel Processing: user_guide/parallel.md
    - Notebooks: user_guide/notebooks.md
    - Extending Spyral: user_guide/extending.md
    - After Spyral: user_guide/continuing.md
  - API Reference:
    - Spyral Reference: api/index.md
    - core:
      - About core: api/core/index.md
      - cluster: api/core/cluster.md
      - clusterize: api/core/clusterize.md
      - config: api/core/config.md
      - constants: api/core/constants.md
      - estimator: api/core/estimator.md
      - hardware_id: api/core/hardware_id.md
      - pad_map: api/core/pad_map.md
      - phase: api/core/phase.md
      - pipeline: api/core/pipeline.md
      - point_cloud: api/core/point_cloud.md
      - run_stacks: api/core/run_stacks.md
      - schema: api/core/schema.md
      - spy_log: api/core/spy_log.md
      - status_message: api/core/status_message.md
      - track_generator: api/core/track_generator.md
      - legacy_beam_pads: api/core/legacy_beam_pads.md
    - correction:
      - About correction: api/correction/index.md
      - generate: api/correction/generate.md
      - electron_corrector: api/correction/electron_corrector.md
    - geometry:
      - About geometry: api/geometry/index.md
      - circle: api/geometry/circle.md
    - interpolate:
      - About interpolate: api/interpolate/index.md
      - bilinear: api/interpolate/bilinear.md
      - linear: api/interpolate/linear.md
      - track_interpolator: api/interpolate/track_interpolator.md
    - phases:
      - About phases: api/phases/index.md
      - pointcloud_phase: api/phases/pointcloud_phase.md
      - cluster_phase: api/phases/cluster_phase.md
      - estimation_phase: api/phases/estimation_phase.md
      - interp_solver_phase: api/phases/interp_solver_phase.md
      - interp_leastsq_solver_phase: api/phases/interp_leastsq_solver_phase.md
      - schema: api/phases/schema.md
    - solvers:
      - About solvers: api/solvers/index.md
      - guess: api/solvers/guess.md
      - solver_interp: api/solvers/solver_interp.md
      - solver_interp_leastsq: api/solvers/solver_interp_leastsq.md
    - trace:
      - About trace: api/trace/index.md
      - get_event: api/trace/get_event.md
      - get_trace: api/trace/get_trace.md
      - frib_event: api/trace/frib_event.md
      - frib_trace: api/trace/frib_trace.md
      - peak: api/trace/peak.md
      - trace_reader: api/trace/trace_reader.md
  - FAQ: faq.md
  - For Developers: CONTRIBUTING.md
  - Contributors: contributors.md

theme:
  name: material
  language: en
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: lime
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            allow_inspection: true
            docstring_style: numpy

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

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