From f74b93631fb6bac502d85a60276b7a25d3dc2bdf Mon Sep 17 00:00:00 2001 From: Felix Kloss Date: Thu, 14 Dec 2023 16:33:53 +0100 Subject: [PATCH] doc: Link to trifinger_docs Add "installation" page that refers to trifinger_docs --- doc/breathing_cat.toml | 1 + doc/installation.rst | 7 +++++++ doc_mainpage.rst | 4 +++- 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 doc/installation.rst diff --git a/doc/breathing_cat.toml b/doc/breathing_cat.toml index c61422a..d5ac9eb 100644 --- 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 new file mode 100644 index 0000000..ec93d09 --- /dev/null +++ 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 index c4703de..9dca512 100644 --- 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 +` 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