aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide
diff options
context:
space:
mode:
authorThéo de la Hogue2023-09-26 17:43:56 +0200
committerThéo de la Hogue2023-09-26 17:43:56 +0200
commit06548cb7cb807f42fa42e4777288f67f259ae64a (patch)
treeda4b990f53828f58de91046ac6997b430e2d44c2 /docs/user_guide
parent6af30f98e4d8c89e4602c4048622ce5e66dbe774 (diff)
downloadargaze-06548cb7cb807f42fa42e4777288f67f259ae64a.zip
argaze-06548cb7cb807f42fa42e4777288f67f259ae64a.tar.gz
argaze-06548cb7cb807f42fa42e4777288f67f259ae64a.tar.bz2
argaze-06548cb7cb807f42fa42e4777288f67f259ae64a.tar.xz
Fixing errors returned by mkdocs serve.
Diffstat (limited to 'docs/user_guide')
-rw-r--r--docs/user_guide/aruco_markers_pipeline/advanced_topics/optic_parameters_calibration.md4
-rw-r--r--docs/user_guide/aruco_markers_pipeline/advanced_topics/scripting.md8
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md2
3 files changed, 7 insertions, 7 deletions
diff --git a/docs/user_guide/aruco_markers_pipeline/advanced_topics/optic_parameters_calibration.md b/docs/user_guide/aruco_markers_pipeline/advanced_topics/optic_parameters_calibration.md
index 0a7ec4d..3277216 100644
--- a/docs/user_guide/aruco_markers_pipeline/advanced_topics/optic_parameters_calibration.md
+++ b/docs/user_guide/aruco_markers_pipeline/advanced_topics/optic_parameters_calibration.md
@@ -134,9 +134,9 @@ Below, an optic_parameters JSON file example:
## Load and display optic parameters
-[ArUcoCamera.detector.optic_parameters](../../argaze.md/#argaze.ArUcoMarkers.ArUcoOpticCalibrator.OpticParameters) can be enabled thanks to a dedicated JSON entry.
+[ArUcoCamera.detector.optic_parameters](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoOpticCalibrator.OpticParameters) can be enabled thanks to a dedicated JSON entry.
-Here is an extract from the JSON [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration file where optic parameters are loaded and displayed:
+Here is an extract from the JSON [ArUcoCamera](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration file where optic parameters are loaded and displayed:
```json
{
diff --git a/docs/user_guide/aruco_markers_pipeline/advanced_topics/scripting.md b/docs/user_guide/aruco_markers_pipeline/advanced_topics/scripting.md
index c1db6d5..0b2ef52 100644
--- a/docs/user_guide/aruco_markers_pipeline/advanced_topics/scripting.md
+++ b/docs/user_guide/aruco_markers_pipeline/advanced_topics/scripting.md
@@ -6,7 +6,7 @@ This could be particularly useful for realtime AR interaction applications.
## Load ArUcoCamera configuration from dictionary
-First of all, [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration can be loaded from a python dictionary.
+First of all, [ArUcoCamera](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration can be loaded from a python dictionary.
```python
from argaze.ArUcoMarkers import ArUcoCamera
@@ -55,7 +55,7 @@ aruco_camera = ArUcoCamera.ArUcoCamera.from_dict(configuration)
## Access to ArUcoCamera and ArScenes attributes
-Then, once the configuration is loaded, it is possible to access to its attributes: [read ArUcoCamera code reference](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) to get a complete list of what is available.
+Then, once the configuration is loaded, it is possible to access to its attributes: [read ArUcoCamera code reference](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) to get a complete list of what is available.
Thus, the [ArUcoCamera.scenes](../../../argaze.md/#argaze.ArFeatures.ArCamera) attribute allows to access each loaded aruco scene and so, access to their attributes: [read ArUcoScene code reference](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoScene) to get a complete list of what is available.
@@ -72,7 +72,7 @@ for name, aruco_scene in aruco_camera.scenes.items():
## Pipeline execution outputs
-[ArUcoCamera.watch](../../argaze.md/#argaze.ArFeatures.ArCamera.watch) method returns many data about pipeline execution.
+[ArUcoCamera.watch](../../../argaze.md/#argaze.ArFeatures.ArCamera.watch) method returns many data about pipeline execution.
```python
# Assuming that images are available
@@ -129,4 +129,4 @@ aruco_camera_image = aruco_camera.image(**image_parameters)
```
!!! note
- [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) inherits from [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) and so, benefits from all image parameters described in [gaze analysis pipeline visualisation section](../../gaze_analysis_pipeline/visualisation.md). \ No newline at end of file
+ [ArUcoCamera](../../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) inherits from [ArFrame](../../../argaze.md/#argaze.ArFeatures.ArFrame) and so, benefits from all image parameters described in [gaze analysis pipeline visualisation section](../../gaze_analysis_pipeline/visualisation.md). \ No newline at end of file
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
index 7796f45..f2e84d6 100644
--- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
+++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md
@@ -34,7 +34,7 @@ To do so, simply prepend the package where to find the module into the JSON conf
}
```
-Then, load your package from the python script where the [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) is created.
+Then, load your package from the python script where the [ArFrame](../../../argaze.md/#argaze.ArFeatures.ArFrame) is created.
```python
from argaze import ArFeatures