site_name: ArGaze documentation
nav:
- index.md
- installation.md
- license.md
- User Guide:
  - Eye Tracking Context:
    - user_guide/eye_tracking_context/introduction.md
    - user_guide/eye_tracking_context/configuration_and_execution.md
    - Context Modules:
      - user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_2.md
      - user_guide/eye_tracking_context/context_modules/tobii_pro_glasses_3.md
      - user_guide/eye_tracking_context/context_modules/pupil_labs_invisible.md
      - user_guide/eye_tracking_context/context_modules/pupil_labs_neon.md
      - user_guide/eye_tracking_context/context_modules/file.md
      - user_guide/eye_tracking_context/context_modules/opencv.md
      - user_guide/eye_tracking_context/context_modules/random.md
    - Advanced Topics:
      - user_guide/eye_tracking_context/advanced_topics/scripting.md
      - user_guide/eye_tracking_context/advanced_topics/context_definition.md
      - user_guide/eye_tracking_context/advanced_topics/timestamped_gaze_positions_edition.md
  - Gaze Analysis Pipeline:
    - user_guide/gaze_analysis_pipeline/introduction.md
    - user_guide/gaze_analysis_pipeline/configuration_and_execution.md
    - user_guide/gaze_analysis_pipeline/aoi_2d_description.md
    - user_guide/gaze_analysis_pipeline/aoi_analysis.md
    - user_guide/gaze_analysis_pipeline/visualization.md
    - user_guide/gaze_analysis_pipeline/recording.md
    - user_guide/gaze_analysis_pipeline/heatmap.md
    - user_guide/gaze_analysis_pipeline/background.md
    - Pipeline Modules:
      - user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_movement_identifiers.md
      - user_guide/gaze_analysis_pipeline/pipeline_modules/scan_path_analyzers.md
      - user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_matchers.md
      - user_guide/gaze_analysis_pipeline/pipeline_modules/aoi_scan_path_analyzers.md
      - user_guide/gaze_analysis_pipeline/pipeline_modules/gaze_position_calibrators.md
    - Advanced Topics:
      - user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
      - user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
      - user_guide/gaze_analysis_pipeline/advanced_topics/gaze_position_calibration.md
  - ArUco Marker Pipeline:
    - user_guide/aruco_marker_pipeline/introduction.md
    - user_guide/aruco_marker_pipeline/aruco_marker_description.md
    - user_guide/aruco_marker_pipeline/configuration_and_execution.md
    - user_guide/aruco_marker_pipeline/pose_estimation.md
    - user_guide/aruco_marker_pipeline/aoi_3d_description.md
    - user_guide/aruco_marker_pipeline/aoi_3d_projection.md
    - user_guide/aruco_marker_pipeline/aoi_3d_frame.md
    - Advanced Topics:
      - user_guide/aruco_marker_pipeline/advanced_topics/scripting.md
      - user_guide/aruco_marker_pipeline/advanced_topics/optic_parameters_calibration.md
      - user_guide/aruco_marker_pipeline/advanced_topics/aruco_detector_configuration.md
  - utils:
    - user_guide/utils/main_commands.md
    - user_guide/utils/demonstrations_scripts.md
    - user_guide/utils/estimate_aruco_markers_pose.md
- Use Cases:
  - Pilot gaze tracking:
    - use_cases/pilot_gaze_tracking/introduction.md
    - use_cases/pilot_gaze_tracking/context.md
    - use_cases/pilot_gaze_tracking/pipeline.md
    - use_cases/pilot_gaze_tracking/observers.md
  - Air traffic controller gaze study:
    - use_cases/air_controller_gaze_study/introduction.md
    - use_cases/air_controller_gaze_study/context.md
    - use_cases/air_controller_gaze_study/pipeline.md
    - use_cases/air_controller_gaze_study/observers.md
  #- Gaze-based candidate selection:
  #  - use_cases/gaze_based_candidate_selection/introduction.md
  #  - use_cases/gaze_based_candidate_selection/context.md
  #  - use_cases/gaze_based_candidate_selection/pipeline.md
  #  - use_cases/gaze_based_candidate_selection/observers.md
- Code Reference:
  - argaze.md
- Contributor Guide:
  - contributor_guide/build_package.md
  - contributor_guide/build_documentation.md
  - contributor_guide/unitary_test.md
theme:
  name: readthedocs
  logo: img/logo-argaze.png
  favicon: img/favicon.ico
  palette:
    primary: #0299D2
extra_css:
  - css/extra.css
plugins:
  - search
  - autorefs
  - include-markdown
  - mkdocs-video
  - mkdocstrings:
      handlers:
        # See: https://mkdocstrings.github.io/python/usage/
        python:
          options:
            docstring_style: google
            allow_inspection: false
            show_source: false
            members_order: 'alphabetical'
            heading_level: 2
            annotations_path: brief
            show_submodules: true
            show_root_toc_entry: false
            show_if_no_docstring: false
            modernize_annotations: true
            filters:
              - "!^__"

watch:
  - src/argaze
markdown_extensions:
  - markdown_include.include:
      base_path: .
  - attr_list
  - admonition