Skip to content

Commit

Permalink
updated landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
mhubii committed Sep 8, 2024
1 parent badfb3a commit 432ac2a
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 10 deletions.
4 changes: 4 additions & 0 deletions doc/img/fri_dependency_architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions doc/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Changelog
=========
Changelog for the corresponding packages:

- ``lbr_fri_ros2_stack``: `Changelog <https://github.com/lbr-stack/lbr_fri_ros2_stack/releases>`_:octicon:`link-external`
- ``pyfri``: `Changlelog <https://github.com/lbr-stack/pyfri/releases>`_:octicon:`link-external`
40 changes: 30 additions & 10 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
.. lbr_fri_ros2_stack documentation master file, created by
sphinx-quickstart on Mon Apr 24 11:26:22 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
LBR-Stack
=========
The ``LBR-Stack`` hosts community contributed extensions to KUKA's Fast Robot Interface (FRI) for accelerated research and deployment. The FRI is KUKA's library for commanding the ``LBR`` over a UDP connection.

.. include:: lbr_fri_ros2_stack/README.md
:parser: myst_parser.sphinx_
The ``LBR-Stack`` provides ``CMake`` support for the FRI. This is further used for ``ROS 2`` integration and ``Python`` bindings, as shown :ref:`below <lbr_stack fri dependency architecture figure>`:

.. _lbr_stack fri dependency architecture figure:
.. thumbnail:: ../img/fri_dependency_architecture.svg
:alt: fri_dependency_architecture

Further documentation is available for:

* `FRI CMake Support <fri/README.html>`_: To see available FRI versions.
* `ROS 2 Integration <lbr_fri_ros2_stack/README.html>`_: ROS 2 packages around the FRI and the LBR (simulation, system integration, safe execution utilities, research, deployment).
* `Python Bindings <pyfri/README.html>`_: Write custom FRI applications without compilation (reserach, experienced users).
* :doc:`Hardware Setup <lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/hardware_setup>`: Java application installation instructions.

.. toctree::
:hidden:
:caption: FRI CMake Support

fri

.. toctree::
:hidden:
:caption: Packages
:caption: ROS 2 Integration

lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/lbr_fri_ros2_stack
lbr_fri_ros2_stack/lbr_bringup/doc/lbr_bringup
Expand All @@ -18,7 +33,12 @@
lbr_fri_ros2_stack/docker/doc/docker
lbr_fri_ros2_stack/lbr_moveit_config/doc/lbr_moveit_config
lbr_fri_idl
fri

.. toctree::
:hidden:
:caption: Python Bindings

pyfri/doc/pyfri

.. toctree::
:hidden:
Expand All @@ -34,5 +54,5 @@
docs/kuka_documentation
Paper <https://arxiv.org/pdf/2311.12709>
contributing
Source Code <https://github.com/lbr-stack/lbr_fri_ros2_stack/tree/humble>
Changelog <https://github.com/lbr-stack/lbr_fri_ros2_stack/releases>
source_code
changelog
8 changes: 8 additions & 0 deletions doc/source/source_code.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Source Code
===========
Source code for the corresponding packages:

- ``fri``: `Source code <https://github.com/lbr-stack/fri>`_:octicon:`link-external`
- ``lbr_fri_ros2_stack``: `Source code <https://github.com/lbr-stack/lbr_fri_ros2_stack>`_:octicon:`link-external`
- ``lbr_fri_idl``: `Source code <https://github.com/lbr-stack/lbr_fri_idl>`_:octicon:`link-external`
- ``pyfri``: `Source code <https://github.com/lbr-stack/pyfri>`_:octicon:`link-external`
Binary file modified paper/img/fri_dependency_architecture.pdf
Binary file not shown.

0 comments on commit 432ac2a

Please sign in to comment.