From 8352274b19ae10cecbdb87f96606bc28157427c8 Mon Sep 17 00:00:00 2001 From: Théo de la Hogue Date: Tue, 6 Jun 2023 17:46:49 +0200 Subject: Working on documentation architecture. --- README.md | 14 +++++++++----- mkdocs.yml | 15 +++++++++++++-- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 42a1326..31a5b63 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ -# Welcome to ArGaze's documentation +# ArGaze documentation + +**Useful links**: [Installation](getting_started#installation) | [Source Repository](https://git.recherche.enac.fr/projects/argaze/repository) | [Issue Tracker](https://git.recherche.enac.fr/projects/argaze/issues) | [Contact](mailto:achil-contact@recherche.enac.fr) + +![Logo](logo-large.png){ width=640px } **ArGaze** is a python toolkit to deal with gaze tracking in **Augmented Reality (AR) environment**. -The ArGaze toolkit provides solutions to build 3D modeled AR environment defining **Areas Of Interest (AOI)** mapped on **OpenCV ArUco markers** and so ease experimentation design with wearable eye tracker device. +The ArGaze toolkit provides solutions to build 3D modeled AR environment defining **Areas Of Interest (AOI)** mapped on OpenCV ArUco markers and so ease experimentation design with wearable eye tracker device. Further, tracked gaze can be projected onto AR environment for live or post **gaze analysis** thanks to **timestamped data** features. ArGaze can be combined with any wearable eye tracking device python library like Tobii or Pupil glasses. -Check out the [installation](getting_started#installation) section to start. - -Check out the [Code reference](argaze) section to get deeper into library architecture. +!!! note + + *This work is greatly inspired by [Andrew T. Duchowski, Vsevolod Peysakhovich and Krzysztof Krejtz article](https://git.recherche.enac.fr/attachments/download/1942/Using_Pose_Estimation_to_Map_Gaze_to_Detected_Fidu.pdf) about using pose estimation to map gaze to detected fiducial markers.* diff --git a/mkdocs.yml b/mkdocs.yml index 685f62e..98b3557 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,15 +1,25 @@ site_name: ArGaze documentation nav: - index.md -- getting_started.md +- Getting Started: + - getting_started/installation.md + - getting_started/ready-made.md + - getting_started/demos.md - Code Reference: - - argaze.md + - argaze.md +- Contributor's Guide: + - contributor_guide/build_documentation.md + - contributor_guide/unitary_test.md theme: name: readthedocs + palette: + primary: #0299D2 extra_css: - css/extra.css plugins: - search + - autorefs + - include-markdown - mkdocstrings: handlers: # See: https://mkdocstrings.github.io/python/usage/ @@ -28,4 +38,5 @@ watch: markdown_extensions: - markdown_include.include: base_path: . + - attr_list - admonition -- cgit v1.1