mkdocs.yml

site_name: DSG-JIT
site_url: https://TannerTorrey3.github.io/DSG-JIT
repo_name: TannerTorrey3/DSG-JIT
repo_url: https://github.com/TannerTorrey3/DSG-JIT

theme:
  name: material
  palette:
    - scheme: slate         # default = dark
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - scheme: default       # optional light mode
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.tracking
    - content.code.annotate
    - content.tabs.link
    - content.code.copy
    - search.highlight
    - search.suggest

nav:
  - Home: index.md
  - Architecture: architecture.md
  - Benchmarks: benchmarks.md
  - Examples: examples.md
  - Roadmap: roadmap.md
  - Glossary: glossary.md
  - API:
      - Core: api/core.md
      - SLAM: api/slam.md
      - Sensors: api/sensors.md
      - Optimization: api/optimization.md
      - Scene Graph: api/scene_graph.md
      - World Model: api/world.md
      - Datasets: api/datasets.md
  - Tutorials:
      - Introduction: tutorials/index.md
      - Core Concepts:
        - Mini World Factor Graph: tutorials/mini_world.md
        - Manifold Geometry SE(3): tutorials/manifold_geometry_se3.md
        - Building a Semantic Scene Graph World: tutorials/scene_graph_world.md
        - Working with Objects in Scene Graphs: tutorials/scene_graph_objects.md
        - Differentiable Voxel Observations: tutorials/differentiable_voxel_obs.md
        - Visualizing a Factor Graph in 3D: tutorials/visual_factor_graph.md
        - 3D Scene Graph Construction & Visualization: tutorials/scenegraph_3d.md
        - Scene Graph Demo - Rooms, Places, Poses, and Objects: tutorials/scenegraph_demo.md
        - Dynamic Scene Graph Demo: tutorials/dynamic_scenegraph_demo.md
      - SE(3) & SLAM:
        - Manifold Geometry SE(3): tutorials/manifold_geometry_se3.md
        - Building a Semantic Scene Graph World: tutorials/scene_graph_world.md
        - Dynamic Trajectories: tutorials/dynamic_trajectories.md
        - Differentiable SE(3) Odometry Chain: tutorials/differentiable_se3_odom_chain.md
        - Learnable Factor-Type Weights in a Scene Graph: tutorials/scenegraph_type_weights.md
        - Hybrid SE(3) & Voxel Joint Parameter Learning: tutorials/hybrid_se3_voxel_joint_learning.md
        - Hybrid Differentiable Scene Graphs: tutorials/hybrid_dsg.md
        - Visualizing a Factor Graph in 3D: tutorials/visual_factor_graph.md
        - 3D Scene Graph Construction & Visualization: tutorials/scenegraph_3d.md
        - Dynamic Scene Graph Demo: tutorials/dynamic_scenegraph_demo.md
        - Sliding‑Window Optimization with Active Templates: tutorials/sliding_window.md
      - Voxel Grids & Spatial Fields:
        - Differentiable Voxel Observations: tutorials/differentiable_voxel_obs.md
        - Multi-Voxel Parameter Optimization: tutorials/multi_voxel_param.md
        - Multi-Voxel Point Observation Learning: tutorials/trainer_voxel_point_multi.md
        - Joint Learning of Voxel Observation Parameters & Type Weights: tutorials/multi_voxel_param_weight.md
        - Hybrid SE(3) & Voxel Joint Parameter Learning: tutorials/hybrid_se3_voxel_joint_learning.md
        - Hybrid Differentiable Scene Graphs: tutorials/hybrid_dsg.md
      - Static Scene Graphs:
        - Build a Sematic Scene Graph World: tutorials/scene_graph_world.md
        - Working with Objects in Scene Graphs: tutorials/scene_graph_objects.md
        - Scene Graph Objects (JIT): tutorials/scene_graph_objects_jit.md
        - Dynamic Trajectories: tutorials/dynamic_trajectories.md
        - Scene Graph Demo - Rooms, Places, Poses, and Objects: tutorials/scenegraph_demo.md
      - Dynamic Scene Graphs:
        - Learnable Factor-Type Weights in a Scene Graph: tutorials/scenegraph_type_weights.md
        - Multi-Voxel Point Observation Learning: tutorials/trainer_voxel_point_multi.md
        - Hybrid SE(3) & Voxel Joint Parameter Learning: tutorials/hybrid_se3_voxel_joint_learning.md
        - Hybrid Differentiable Scene Graphs: tutorials/hybrid_dsg.md
        - 3D Scene Graph Construction & Visualization: tutorials/scenegraph_3d.md
        - Dynamic Scene Graph Demo: tutorials/dynamic_scenegraph_demo.md
        - Range Sensor Dynamic Scene Graph: tutorials/range_sensor_dsg.md
        - Sensor DSG Mapping (End-to-End): tutorials/sensor_dsg_mapping.md
        - Sliding‑Window Optimization with Active Templates: tutorials/sliding_window.md
      - Sensors & Fusion:
        - Range Sensor Dynamic Scene Graph: tutorials/range_sensor_dsg.md
        - Sensor Fusion Sandbox - Camera, LiDAR, and IMU Streams: tutorials/sensor_fusion_demo.md
        - Sensor DSG Mapping (End-to-End): tutorials/sensor_dsg_mapping.md
      - Learning & Hybrid Modules:
        - Multi-Voxel Parameter Optimization: tutorials/multi_voxel_param.md
        - Differentiable SE(3) Odometry Chain: tutorials/differentiable_se3_odom_chain.md
        - Learning Factor-Type Weights: tutorials/learn_type_weights.md
        - Learnable Factor-Type Weights in a Scene Graph: tutorials/scenegraph_type_weights.md
        - Multi-Voxel Point Observation Learning: tutorials/trainer_voxel_point_multi.md
        - Joint Learning of Voxel Observation Parameters & Type Weights: tutorials/multi_voxel_param_weight.md
        - Hybrid SE(3) & Voxel Joint Parameter Learning: tutorials/hybrid_se3_voxel_joint_learning.md
        - Hybrid Differentiable Scene Graphs: tutorials/hybrid_dsg.md
      - JAX & JIT:
        - Scene Graph Objects (JIT): tutorials/scene_graph_objects_jit.md
        - Differentiable Voxel Observations: tutorials/differentiable_voxel_obs.md
        - Visualizing a Factor Graph in 3D: tutorials/visual_factor_graph.md
        - Sliding‑Window Optimization with Active Templates: tutorials/sliding_window.md

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths:
            - dsg-jit/dsg_jit
          options:
            show_source: true
            show_signature: true
            show_root_toc_entry: false
            heading_level: 2
            docstring_style: google
            merge_init_into_class: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format