Merge pull request #48 from open-dynamic-robot-initiative/fkloss/doc

doc: Link to trifinger_docs
open-dynamic-robot-initiative · Dec 14, 2023 · 26e0944 · 26e0944
2 parents 17a4837 + f74b936
commit 26e0944
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/doc/breathing_cat.toml b/doc/breathing_cat.toml
@@ -2,6 +2,7 @@
 exclude_patterns = ["${PACKAGE_DIR}/include/optim/*"]
 
 [intersphinx.mapping]
+trifinger_docs = "https://open-dynamic-robot-initiative.github.io/trifinger_docs"
 trifinger_cameras = "https://open-dynamic-robot-initiative.github.io/trifinger_cameras"
 
 [mainpage]

diff --git a/doc/installation.rst b/doc/installation.rst
@@ -0,0 +1,7 @@
+************
+Installation
+************
+
+The ``trifinger_object_tracking`` package is part of the TriFinger software
+bundle.  See :ref:`trifinger_docs:install_software` in the TriFinger
+documentation.
diff --git a/doc_mainpage.rst b/doc_mainpage.rst
@@ -2,7 +2,8 @@
 .. image:: doc/images/detection_example_cube.jpg
    :alt: Example showing the result of the pose detection.
 
-Multi-camera pose estimation of coloured cuboids for the TriFinger robots.
+Multi-camera pose estimation of coloured cuboids for the :doc:`TriFinger
+<trifinger_docs:index>` robots.
 
 Detect coloured cuboids (with a different colour on each side) using images from
 three cameras.  This is used for object detection in the TriFinger robot
@@ -16,6 +17,7 @@ if you have a question or want to report a bug.
    :caption: General Documentation
    :maxdepth: 1
 
+   doc/installation.rst
    doc/a1_introduction.rst
    doc/a2_cube_model.rst
    doc/b1_train_colour_segmentation.rst