Skip to content
Merged
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,13 @@
# lbr_fri_ros2_stack_doc
[![Documentation Status](https://readthedocs.org/projects/lbr-fri-ros2-stack-doc/badge/?version=humble)](https://lbr-fri-ros2-stack-doc.readthedocs.io/en/humble/?badge=humble)

This repository holds the documentation for [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack).

## Acknowledgements
<img src="https://www.kcl.ac.uk/newimages/Wellcome-EPSRC-Centre-medical-engineering-logo.xa827df3f.JPG?f=webp" alt="wellcome" height="45" width="65" align="left">

This work was supported by core and project funding from the Wellcome/EPSRC [WT203148/Z/16/Z; NS/A000049/1; WT101957; NS/A000027/1].

<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/b/b7/Flag_of_Europe.svg/1920px-Flag_of_Europe.svg.png" alt="eu_flag" height="45" width="65" align="left" >

This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101016985 (FAROS project).
4 changes: 3 additions & 1 deletion doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = []
extensions = [
"sphinx_mdinclude"
]

templates_path = ['_templates']
exclude_patterns = []
Expand Down
13 changes: 13 additions & 0 deletions doc/source/docs/additional_resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Additional Resources
====================
**Note**: These resources may **not** be re-distributed but are accesible on `KUKA Xpert <https://xpert.kuka.com>`_.

For internal use only, below are links to the school's `Sharepoint <https://emckclac.sharepoint.com>`_:

* Hardware:
* `LBR Med Quickstart <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/LBR_Med_Quick_Start_en.pdf>`_
* `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/GA_LBR_Med_en.pdf>`_
* `KUKA Sunrise Cabinet Med, Instructions for Use <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/GA_KUKA_Sunrise_Cabinet_Med_en.pdf>`_
* Software:
* `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/GA_KUKA_SunriseOS_Med_115_en.pdf>`_
* `KUKA Sunrise.FRI 1.15 <https://emckclac.sharepoint.com/sites/MT-BMEIS-RVIM/Shared%20Documents/docs/inventory/kuka_lbr_med_7_R800/KUKA_SunriseFRI_115_en.pdf>`_
2 changes: 2 additions & 0 deletions doc/source/docs/demos.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Demos
=====
2 changes: 2 additions & 0 deletions doc/source/docs/real_robot_setup.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Real Robot Setup
================
2 changes: 2 additions & 0 deletions doc/source/docs/software_architecture.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Software Architecture
=====================
15 changes: 8 additions & 7 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
.. lbr_fri_ros2 documentation master file, created by
.. 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.

Welcome to lbr_fri_ros2's documentation!
==============================================
.. mdinclude:: ../../lbr_fri_ros2_stack/README.md



API
===
.. toctree::
:hidden:

docs/doxygen/lbr_fri_ros2/html/index
docs/additional_resources
docs/demos
docs/real_robot_setup
docs/software_architecture
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
doxysphinx
sphinx-mdinclude