From bdfe81bc2df3042ea71fbd6814d50672438ec5cf Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 12:40:43 +0100 Subject: [PATCH 01/17] added rst files --- doc/source/docs/demos.rst | 2 ++ doc/source/docs/real_robot_setup.rst | 2 ++ doc/source/index.rst | 11 ++++++----- 3 files changed, 10 insertions(+), 5 deletions(-) create mode 100644 doc/source/docs/demos.rst create mode 100644 doc/source/docs/real_robot_setup.rst diff --git a/doc/source/docs/demos.rst b/doc/source/docs/demos.rst new file mode 100644 index 0000000..85dfc1d --- /dev/null +++ b/doc/source/docs/demos.rst @@ -0,0 +1,2 @@ +Demos +===== diff --git a/doc/source/docs/real_robot_setup.rst b/doc/source/docs/real_robot_setup.rst new file mode 100644 index 0000000..07bc2e5 --- /dev/null +++ b/doc/source/docs/real_robot_setup.rst @@ -0,0 +1,2 @@ +Real Robot Setup +================ diff --git a/doc/source/index.rst b/doc/source/index.rst index 29a2e16..8bcc161 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,10 +5,11 @@ Welcome to lbr_fri_ros2's documentation! ============================================== - - - -API -=== .. toctree:: + :hidden: docs/doxygen/lbr_fri_ros2/html/index + docs/demos.rst + docs/real_robot_setup.rst + +Quick Start +=========== From b7b3351eb245bcb865bd05b8a9ff8fad4a4f644f Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 12:56:08 +0100 Subject: [PATCH 02/17] added architecture --- doc/source/docs/software_architecture.rst | 2 ++ doc/source/index.rst | 3 +++ 2 files changed, 5 insertions(+) create mode 100644 doc/source/docs/software_architecture.rst diff --git a/doc/source/docs/software_architecture.rst b/doc/source/docs/software_architecture.rst new file mode 100644 index 0000000..93fbec1 --- /dev/null +++ b/doc/source/docs/software_architecture.rst @@ -0,0 +1,2 @@ +Software Architecture +===================== diff --git a/doc/source/index.rst b/doc/source/index.rst index 8bcc161..a195718 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,9 +7,12 @@ Welcome to lbr_fri_ros2's documentation! ============================================== .. toctree:: :hidden: + docs/doxygen/lbr_fri_ros2/html/index docs/demos.rst docs/real_robot_setup.rst + docs/software_architecture.rst Quick Start =========== + From 6f0d58fe121ab6c56e277784f80226a2915577d8 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 12:58:50 +0100 Subject: [PATCH 03/17] updated readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0927ab2..2f39806 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ -# lbr_fri_ros2_stack_doc +# lbr_fri_ros2_doc +This repository holds the documentation for [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). +[![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) + +## Acknowledgements +wellcome + +This work was supported by core and project funding from the Wellcome/EPSRC [WT203148/Z/16/Z; NS/A000049/1; WT101957; NS/A000027/1]. + +eu_flag + +This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No 101016985 (FAROS project). From 0d543fb760c6346a6ffb4919e14d2a98abc27ddf Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:04:05 +0100 Subject: [PATCH 04/17] added contents --- doc/source/index.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index a195718..e0bd73e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,13 +5,15 @@ Welcome to lbr_fri_ros2's documentation! ============================================== -.. toctree:: - :hidden: + +Contents +======== +.. toctree:: docs/doxygen/lbr_fri_ros2/html/index - docs/demos.rst - docs/real_robot_setup.rst - docs/software_architecture.rst + docs/demos + docs/real_robot_setup + docs/software_architecture Quick Start =========== From ecbea94e07c2b04fa9394f52284b655dbd904238 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:12:29 +0100 Subject: [PATCH 05/17] renamed --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f39806..3ccd5ab 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # lbr_fri_ros2_doc -This repository holds the documentation for [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). +This repository holds the documentation for [lbr_fri_ros2](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). [![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) From c17de3bfe8527498670a07c3c9119787f619a66e Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:12:50 +0100 Subject: [PATCH 06/17] renamed --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ccd5ab..81c12c2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# lbr_fri_ros2_doc -This repository holds the documentation for [lbr_fri_ros2](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). +# lbr_fri_ros2_stack_doc +This repository holds the documentation for [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). [![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) From 1d1c0c235e9c805468bd5a63c034b2e77eb27f20 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:15:01 +0100 Subject: [PATCH 07/17] moved doc badge --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 81c12c2..b555581 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # lbr_fri_ros2_stack_doc -This repository holds the documentation for [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). - [![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 wellcome From 4649ea8fcdc87e1fb79a4fdee84654c887e79dcb Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:27:49 +0100 Subject: [PATCH 08/17] added readme --- doc/source/index.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index e0bd73e..0f72f81 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,11 +1,9 @@ -.. 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 Contents ======== @@ -14,7 +12,3 @@ Contents docs/demos docs/real_robot_setup docs/software_architecture - -Quick Start -=========== - From afcf2f0b44648ea892bf4a869279d33d5751d7ac Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:49:08 +0100 Subject: [PATCH 09/17] added readme --- doc/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 0f72f81..6ff02da 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,9 +5,9 @@ .. mdinclude:: ../../lbr_fri_ros2_stack/README.md -Contents -======== .. toctree:: + :hidden: + docs/doxygen/lbr_fri_ros2/html/index docs/demos docs/real_robot_setup From a1321f61fce215adfaa3dddfeb0b64e21b912770 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 13:57:51 +0100 Subject: [PATCH 10/17] added myst parser --- doc/source/conf.py | 4 +++- requirements.txt | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index d39b3f6..c4ecae2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -25,7 +25,9 @@ # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = [ + "myst_parser" +] templates_path = ['_templates'] exclude_patterns = [] diff --git a/requirements.txt b/requirements.txt index efc23a7..f5ead50 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ doxysphinx +myst_parser From d2ed550963d8d644878a2bd7621efa8b2edc8841 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 14:01:40 +0100 Subject: [PATCH 11/17] changed to sphinx md include --- doc/source/conf.py | 2 +- requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index c4ecae2..e31fa9a 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,7 +26,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ - "myst_parser" + "sphinx_mdinclude" ] templates_path = ['_templates'] diff --git a/requirements.txt b/requirements.txt index f5ead50..d10c198 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ doxysphinx -myst_parser +sphinx-mdinclude From ccc5b226f81d3f03c7e05223a5980976e1cfd5d3 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 16:54:22 +0100 Subject: [PATCH 12/17] added additional resources --- doc/source/docs/additional_resources.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 doc/source/docs/additional_resources.rst diff --git a/doc/source/docs/additional_resources.rst b/doc/source/docs/additional_resources.rst new file mode 100644 index 0000000..c7c616d --- /dev/null +++ b/doc/source/docs/additional_resources.rst @@ -0,0 +1,12 @@ +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`_ From de9018f24ec43b772c167f9977838145aa648b06 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 16:56:05 +0100 Subject: [PATCH 13/17] added additional resources --- doc/source/index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/source/index.rst b/doc/source/index.rst index 6ff02da..9989029 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,7 @@ :hidden: docs/doxygen/lbr_fri_ros2/html/index + docs/additional_resources docs/demos docs/real_robot_setup docs/software_architecture From 4fb7554e7cf863d1b30c51a4e9ea677d25b79658 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 17:00:07 +0100 Subject: [PATCH 14/17] fixed links --- doc/source/docs/additional_resources.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/source/docs/additional_resources.rst b/doc/source/docs/additional_resources.rst index c7c616d..c39b463 100644 --- a/doc/source/docs/additional_resources.rst +++ b/doc/source/docs/additional_resources.rst @@ -1,12 +1,12 @@ Additional Resources ==================== -**Note**: These resources may not be re-distributed but are accesible on `KUKA Xpert https://xpert.kuka.com/`_. +**Note**: These resources may not be re-distributed but are accesible on `KUKA Xpert `_. -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`_ +For internal use only, below are links to the school's `Sharepoint `_: +* Hardware + * `LBR Med Quickstart `_ + * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use `_ + * `KUKA Sunrise Cabinet Med, Instructions for Use `_ +* Software + * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators `_ + * `KUKA Sunrise.FRI 1.15 `_ From 5cff5eb2e2790124cc58f58b42861b66bbda6ad5 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 17:02:25 +0100 Subject: [PATCH 15/17] fixed list --- doc/source/docs/additional_resources.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/source/docs/additional_resources.rst b/doc/source/docs/additional_resources.rst index c39b463..eaa25e3 100644 --- a/doc/source/docs/additional_resources.rst +++ b/doc/source/docs/additional_resources.rst @@ -1,8 +1,9 @@ Additional Resources ==================== -**Note**: These resources may not be re-distributed but are accesible on `KUKA Xpert `_. +**Note**: These resources may **not** be re-distributed but are accesible on `KUKA Xpert `_. For internal use only, below are links to the school's `Sharepoint `_: + * Hardware * `LBR Med Quickstart `_ * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use `_ From cd383bd32897a465966a6ee70da35472cafdc40c Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 17:06:29 +0100 Subject: [PATCH 16/17] fixed list --- doc/source/docs/additional_resources.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/docs/additional_resources.rst b/doc/source/docs/additional_resources.rst index eaa25e3..5c03ff6 100644 --- a/doc/source/docs/additional_resources.rst +++ b/doc/source/docs/additional_resources.rst @@ -4,10 +4,10 @@ Additional Resources For internal use only, below are links to the school's `Sharepoint `_: -* Hardware - * `LBR Med Quickstart `_ - * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use `_ - * `KUKA Sunrise Cabinet Med, Instructions for Use `_ -* Software - * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators `_ - * `KUKA Sunrise.FRI 1.15 `_ +* Hardware: + * `LBR Med Quickstart `_ + * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use `_ + * `KUKA Sunrise Cabinet Med, Instructions for Use `_ +* Software: + * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators `_ + * `KUKA Sunrise.FRI 1.15 `_ From 795059e2ebb0b92683769e065e8df98c2d086467 Mon Sep 17 00:00:00 2001 From: mhubii Date: Mon, 24 Apr 2023 17:09:14 +0100 Subject: [PATCH 17/17] finalized links --- doc/source/docs/additional_resources.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/source/docs/additional_resources.rst b/doc/source/docs/additional_resources.rst index 5c03ff6..d65d100 100644 --- a/doc/source/docs/additional_resources.rst +++ b/doc/source/docs/additional_resources.rst @@ -5,9 +5,9 @@ Additional Resources For internal use only, below are links to the school's `Sharepoint `_: * Hardware: - * `LBR Med Quickstart `_ - * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use `_ - * `KUKA Sunrise Cabinet Med, Instructions for Use `_ + * `LBR Med Quickstart `_ + * `LBR Med 7 R800, LBR Med 14 R820, Insructions for Use `_ + * `KUKA Sunrise Cabinet Med, Instructions for Use `_ * Software: - * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators `_ - * `KUKA Sunrise.FRI 1.15 `_ + * `KUKA Sunrise.OS Med 1.15, KUKA Sunrise.Workbench Med 1.15, Operating and Programming Instructions for System Integrators `_ + * `KUKA Sunrise.FRI 1.15 `_