site_name: ArGaze documentation
nav:
- index.md
- installation.md
- license.md
- User Guide:
  - Gaze Analysis Pipeline:
    - user_guide/gaze_analysis_pipeline/introduction.md
    - user_guide/gaze_analysis_pipeline/timestamped_gaze_positions_edition.md
    - user_guide/gaze_analysis_pipeline/ar_frame_configuration_and_execution.md
    - user_guide/gaze_analysis_pipeline/ar_layer.md
    - user_guide/gaze_analysis_pipeline/visualisation.md
    - user_guide/gaze_analysis_pipeline/logging.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
    - Advanced Topics:
      - user_guide/gaze_analysis_pipeline/advanced_topics/scripting.md
      - user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
#  - ArUco Markers: 
#    - user_guide/aruco_markers/introduction.md
#    - user_guide/aruco_markers/dictionary_selection.md
#    - user_guide/aruco_markers/markers_creation.md
#    - user_guide/aruco_markers/camera_calibration.md
#    - user_guide/aruco_markers/markers_detection.md
#    - user_guide/aruco_markers/markers_pose_estimation.md
#    - user_guide/aruco_markers/markers_scene_description.md
#  - Areas Of Interest: 
#    - user_guide/areas_of_interest/introduction.md
#    - user_guide/areas_of_interest/aoi_scene_description.md
#    - user_guide/areas_of_interest/aoi_scene_projection.md
#    - user_guide/areas_of_interest/vision_cone_filtering.md
#    - user_guide/areas_of_interest/aoi_matching.md
#    - user_guide/areas_of_interest/heatmap.md
#  - Augmented Reality environment:
#    - user_guide/ar_camera/introduction.md
#    - user_guide/ar_camera/environment_setup.md
#    - user_guide/ar_camera/environment_exploitation.md
#  - Gaze Analysis:
#    - user_guide/gaze_analysis/introduction.md
#    - user_guide/gaze_analysis/gaze_position.md
#    - user_guide/gaze_analysis/gaze_movement.md
#    - user_guide/gaze_analysis/scan_path.md
#  - Timestamped data:
#    - user_guide/timestamped_data/introduction.md
#    - user_guide/timestamped_data/ordered_dictionary.md
#    - user_guide/timestamped_data/saving_and_loading.md
#    - user_guide/timestamped_data/data_synchronisation.md
#    - user_guide/timestamped_data/pandas_dataframe_conversion.md
  - utils:
    - user_guide/utils/ready-made_scripts.md
    - user_guide/utils/demonstrations_scripts.md
- Use Cases:
  - use_cases/simone_a320_cockpit_simulator.md
- Code Reference:
  - argaze.md
- Contributor Guide:
  - 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
watch:
  - src/argaze
markdown_extensions:
  - markdown_include.include:
      base_path: .
  - attr_list
  - admonition