Skip to content

Commit 432ac2a

Browse files
committed
updated landing page
1 parent badfb3a commit 432ac2a

5 files changed

Lines changed: 48 additions & 10 deletions

File tree

doc/img/fri_dependency_architecture.svg

Lines changed: 4 additions & 0 deletions
Loading

doc/source/changelog.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Changelog
2+
=========
3+
Changelog for the corresponding packages:
4+
5+
- ``lbr_fri_ros2_stack``: `Changelog <https://github.com/lbr-stack/lbr_fri_ros2_stack/releases>`_:octicon:`link-external`
6+
- ``pyfri``: `Changlelog <https://github.com/lbr-stack/pyfri/releases>`_:octicon:`link-external`

doc/source/index.rst

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1-
.. lbr_fri_ros2_stack documentation master file, created by
2-
sphinx-quickstart on Mon Apr 24 11:26:22 2023.
3-
You can adapt this file completely to your liking, but it should at least
4-
contain the root `toctree` directive.
1+
LBR-Stack
2+
=========
3+
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.
54

6-
.. include:: lbr_fri_ros2_stack/README.md
7-
:parser: myst_parser.sphinx_
5+
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>`:
6+
7+
.. _lbr_stack fri dependency architecture figure:
8+
.. thumbnail:: ../img/fri_dependency_architecture.svg
9+
:alt: fri_dependency_architecture
10+
11+
Further documentation is available for:
12+
13+
* `FRI CMake Support <fri/README.html>`_: To see available FRI versions.
14+
* `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).
15+
* `Python Bindings <pyfri/README.html>`_: Write custom FRI applications without compilation (reserach, experienced users).
16+
* :doc:`Hardware Setup <lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/hardware_setup>`: Java application installation instructions.
17+
18+
.. toctree::
19+
:hidden:
20+
:caption: FRI CMake Support
21+
22+
fri
823

924
.. toctree::
1025
:hidden:
11-
:caption: Packages
26+
:caption: ROS 2 Integration
1227

1328
lbr_fri_ros2_stack/lbr_fri_ros2_stack/doc/lbr_fri_ros2_stack
1429
lbr_fri_ros2_stack/lbr_bringup/doc/lbr_bringup
@@ -18,7 +33,12 @@
1833
lbr_fri_ros2_stack/docker/doc/docker
1934
lbr_fri_ros2_stack/lbr_moveit_config/doc/lbr_moveit_config
2035
lbr_fri_idl
21-
fri
36+
37+
.. toctree::
38+
:hidden:
39+
:caption: Python Bindings
40+
41+
pyfri/doc/pyfri
2242

2343
.. toctree::
2444
:hidden:
@@ -34,5 +54,5 @@
3454
docs/kuka_documentation
3555
Paper <https://arxiv.org/pdf/2311.12709>
3656
contributing
37-
Source Code <https://github.com/lbr-stack/lbr_fri_ros2_stack/tree/humble>
38-
Changelog <https://github.com/lbr-stack/lbr_fri_ros2_stack/releases>
57+
source_code
58+
changelog

doc/source/source_code.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Source Code
2+
===========
3+
Source code for the corresponding packages:
4+
5+
- ``fri``: `Source code <https://github.com/lbr-stack/fri>`_:octicon:`link-external`
6+
- ``lbr_fri_ros2_stack``: `Source code <https://github.com/lbr-stack/lbr_fri_ros2_stack>`_:octicon:`link-external`
7+
- ``lbr_fri_idl``: `Source code <https://github.com/lbr-stack/lbr_fri_idl>`_:octicon:`link-external`
8+
- ``pyfri``: `Source code <https://github.com/lbr-stack/pyfri>`_:octicon:`link-external`
1.51 KB
Binary file not shown.

0 commit comments

Comments
 (0)