Skip to content

Commit

Permalink
Add installation guide
Browse files Browse the repository at this point in the history
So far only points to robot_fingers docs.
  • Loading branch information
luator committed Dec 14, 2023
1 parent f925dbc commit a4a1033
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 20 deletions.
12 changes: 12 additions & 0 deletions howto/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _install_software:

********************
Install the Software
********************

This is currently described in :doc:`robot_fingers:doc/installation`.

.. todo::

Move the installation instructions to this documentation and link to it from
the package docs.
6 changes: 6 additions & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ points to more specific documentations (e.g. of individual packages) where appro
Content
=======

.. toctree::
:caption: How-to Guides
:maxdepth: 1

howto/installation

.. toctree::
:caption: References
:maxdepth: 1
Expand Down
35 changes: 15 additions & 20 deletions package_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,10 @@
Software Package Overview
*************************

.. todo::

- mention treep ROBOT_FINGERS.
- not on this page but this docs should contain the installation instructions
(i.e. move from the package docs to here)
- probably not all packages need to be mentioned here

- Use intersphinx for documentation links
Below the main software packages used for to the TriFinger robots are listed. See
:ref:`install_software` on how to install them. Note that the installation will include
some additional utility packages from the ODRI project. Below are only the packages
that are specifically written for the TriFinger robots.


- **robot_interfaces** --- [`source <https://github.com/open-dynamic-robot-initiative/robot_interfaces>`__ | :doc:`docs <robot_interfaces:index>`]
Expand Down Expand Up @@ -49,15 +45,14 @@ Software Package Overview
probably not list the below ones, just mention that there are more packages which are
all cloned via treep.

- cli_utils --- [`source <https://github.com/MPI-IS/cli_utils>`__]
- googletest --- [`source <https://github.com/google/googletest>`__]
- mpi_cmake_modules --- [`source <https://github.com/machines-in-motion/mpi_cmake_modules>`__]
- pybind11 --- [`source <https://github.com/pybind/pybind11>`__]
- pybind11_opencv --- [`source <https://github.com/open-dynamic-robot-initiative/pybind11_opencv>`__]
- real_time_tools --- [`source <https://github.com/machines-in-motion/real_time_tools>`__]
- serialization_utils --- [`source <https://github.com/MPI-IS/serialization_utils>`__]
- shared_memory --- [`source <https://github.com/machines-in-motion/shared_memory>`__]
- signal_handler --- [`source <https://github.com/MPI-IS/signal_handler>`__]
- time_series --- [`source <https://github.com/machines-in-motion/time_series>`__]
- yaml_utils --- [`source <https://github.com/machines-in-motion/yaml_utils>`__]

- cli_utils --- [`source <https://github.com/MPI-IS/cli_utils>`__]
- googletest --- [`source <https://github.com/google/googletest>`__]
- mpi_cmake_modules --- [`source <https://github.com/machines-in-motion/mpi_cmake_modules>`__]
- pybind11 --- [`source <https://github.com/pybind/pybind11>`__]
- pybind11_opencv --- [`source <https://github.com/open-dynamic-robot-initiative/pybind11_opencv>`__]
- real_time_tools --- [`source <https://github.com/machines-in-motion/real_time_tools>`__]
- serialization_utils --- [`source <https://github.com/MPI-IS/serialization_utils>`__]
- shared_memory --- [`source <https://github.com/machines-in-motion/shared_memory>`__]
- signal_handler --- [`source <https://github.com/MPI-IS/signal_handler>`__]
- time_series --- [`source <https://github.com/machines-in-motion/time_series>`__]
- yaml_utils --- [`source <https://github.com/machines-in-motion/yaml_utils>`__]

0 comments on commit a4a1033

Please sign in to comment.