diff options
| author | Théo de la Hogue | 2023-06-07 14:34:14 +0200 |
|---|---|---|
| committer | Théo de la Hogue | 2023-06-07 14:34:14 +0200 |
| commit | c4552e04e1271a9210a934233beae5be1943d034 (patch) | |
| tree | a44041e544bc700976237bfea9058ec06f9a2904 /mkdocs.yml | |
| parent | bd9cd27c9d44c072164f564ffffeb22e37106b89 (diff) | |
| download | argaze-c4552e04e1271a9210a934233beae5be1943d034.zip argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.gz argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.bz2 argaze-c4552e04e1271a9210a934233beae5be1943d034.tar.xz | |
Writing User guide and use cases section.
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 44 |
1 files changed, 39 insertions, 5 deletions
@@ -1,17 +1,50 @@ site_name: ArGaze documentation nav: - index.md -- Getting Started: - - getting_started/installation.md - - getting_started/ready-made.md - - getting_started/demos.md +- installation.md +- license.md +- User Guide: + - 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_projection.md + - user_guide/areas_of_interest/vision_cone_filtering.md + - user_guide/areas_of_interest/aoi_matching.md + - user_guide/areas_of_interest/aoi_frame.md + - Augmented Reality environment: + - user_guide/ar_environment/introduction.md + - user_guide/ar_environment/environment_setup.md + - user_guide/ar_environment/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 +- Use Cases: + - use_cases/simone_a320_cockpit_simulator.md - Code Reference: - argaze.md -- Contributor's Guide: +- 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: @@ -20,6 +53,7 @@ plugins: - search - autorefs - include-markdown + - mkdocs-video - mkdocstrings: handlers: # See: https://mkdocstrings.github.io/python/usage/ |