From 421352732e3f432ffd1df242181133845ac51ee4 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 18 Jul 2023 00:29:17 +0000 Subject: [PATCH 1/6] Update submodules --- doxygen-awesome-css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxygen-awesome-css b/doxygen-awesome-css index df83fbf..00a52f6 160000 --- a/doxygen-awesome-css +++ b/doxygen-awesome-css @@ -1 +1 @@ -Subproject commit df83fbf22cfff76b875c13d324baf584c74e96d0 +Subproject commit 00a52f6c74065ffbd836cbd791ddfe8edf2836b8 From 50e912dd637ef361a53b4ebaadd73868f682ee21 Mon Sep 17 00:00:00 2001 From: mhubii Date: Thu, 3 Aug 2023 11:31:32 +0100 Subject: [PATCH 2/6] changed ref --- .github/workflows/update_submodules.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/update_submodules.yml b/.github/workflows/update_submodules.yml index 9f7eba9..82925ea 100644 --- a/.github/workflows/update_submodules.yml +++ b/.github/workflows/update_submodules.yml @@ -11,7 +11,7 @@ jobs: - name: Checkout submodules uses: actions/checkout@v3 with: - ref: humble + ref: main submodules: true - name: Update submodules run: | @@ -24,4 +24,4 @@ jobs: - name: Push changes uses: ad-m/github-push-action@master with: - branch: humble + branch: main From 1713cb53be7b7ba62a22e315db040056a85c3b8b Mon Sep 17 00:00:00 2001 From: mhubii Date: Tue, 5 Sep 2023 20:25:36 +0100 Subject: [PATCH 3/6] version bump --- doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 548e2bd..0f2c7ee 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -30,7 +30,7 @@ project = "lbr_fri_ros2_stack" copyright = "2023, mhubii" author = "mhubii" -release = "1.2.0" +release = "1.2.5" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration From 7f74d8a4b3524c1ac70a3d9abfdafd95b71c235b Mon Sep 17 00:00:00 2001 From: mhubii Date: Tue, 5 Sep 2023 20:35:52 +0100 Subject: [PATCH 4/6] kcl-bmeis -> lbr-stack --- .readthedocs.yml | 2 +- README.md | 6 +++--- doc/source/conf.py | 4 ++-- doc/source/index.rst | 2 +- paper/paper.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 78d485f..79896ea 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,7 +12,7 @@ build: - graphviz jobs: post_install: - - wget https://raw.githubusercontent.com/KCL-BMEIS/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos.yml + - wget https://raw.githubusercontent.com/lbr-stack/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos.yml - vcs import doc/source < repos.yml python: diff --git a/README.md b/README.md index 56c3708..634eb91 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # 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 the [lbr_fri_ros2_stack](https://github.com/KCL-BMEIS/lbr_fri_ros2_stack). +This repository holds the documentation for the [lbr_fri_ros2_stack](https://github.com/lbr-stack/lbr_fri_ros2_stack). ## Build Documentation Locally To build locally: 1. Clone this repository ```shell -git clone --recursive git@github.com:KCL-BMEIS/lbr_fri_ros2_stack_doc.git +git clone --recursive git@github.com:lbr-stack/lbr_fri_ros2_stack_doc.git cd lbr_fri_ros2_stack_doc ``` 2. Clone the `lbr_fri_ros2_stack`, e.g. via (this uses [vcs](https://github.com/dirk-thomas/vcstool#how-to-install-vcstool)) ```shell -wget https://raw.githubusercontent.com/KCL-BMEIS/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos.yml +wget https://raw.githubusercontent.com/lbr-stack/lbr_fri_ros2_stack/humble/lbr_fri_ros2_stack/repos.yml vcs import doc/source < repos.yml ``` diff --git a/doc/source/conf.py b/doc/source/conf.py index 0f2c7ee..fa9b49b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -75,10 +75,10 @@ html_theme = "pydata_sphinx_theme" html_theme_options = { - "github_url": "https://github.com/kCL-BMEIS/lbr_fri_ros2_stack/tree/humble", + "github_url": "https://github.com/lbr-stack/lbr_fri_ros2_stack/tree/humble", "switcher": { "version_match": "humble", - "json_url": "https://raw.githubusercontent.com/KCL-BMEIS/lbr_fri_ros2_stack_doc/humble/doc/source/switcher.json", + "json_url": "https://raw.githubusercontent.com/lbr-stack/lbr_fri_ros2_stack_doc/humble/doc/source/switcher.json", }, "navbar_start": ["navbar-logo", "version-switcher"], } diff --git a/doc/source/index.rst b/doc/source/index.rst index 490fd2b..3bbb3f7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,4 +21,4 @@ :hidden: :caption: Getting Involved - Source Code + Source Code diff --git a/paper/paper.md b/paper/paper.md index 9a12503..5d14938 100644 --- a/paper/paper.md +++ b/paper/paper.md @@ -80,7 +80,7 @@ The first original contribution of this work is to add support for the `KUKA LBR | Framework | iiwa | Med | ROS | ROS 2 | RT | FRI | Pos | Imp | Cart Imp | HW IF | | --------------- | ---- |---- | --- | ------ | -- | ---- | --- | --- | -------- | ------ | -|[lbr_fri_ros2_stack](https://github.com/kCL-BMEIS/lbr_fri_ros2_stack) | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | +|[lbr_fri_ros2_stack](https://github.com/lbr-stack/lbr_fri_ros2_stack) | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | \bullet | | [iiwa_ros](https://github.com/epfl-lasa/iiwa_ros) | \bullet | | \bullet | | \bullet | \bullet | \bullet | \bullet | | \bullet | | [iiwa_ros2](https://github.com/ICube-Robotics/iiwa_ros2) | \bullet | | | \bullet | \bullet | \bullet | \bullet | \bullet | | \bullet | | [iiwa-stack](https://github.com/IFL-CAMP/iiwa_stack) | \bullet | | \bullet | | | | \bullet | \bullet | \bullet | | From 449435e259b3d9aa9925c8cf56315f58cb8a72ee Mon Sep 17 00:00:00 2001 From: Martin Huber Date: Tue, 19 Sep 2023 17:44:22 +0100 Subject: [PATCH 5/6] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ba78d0d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Martin Huber + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From c50715d3d0633d94650d03ee17d183e061961df5 Mon Sep 17 00:00:00 2001 From: mhubii Date: Tue, 21 Nov 2023 13:59:59 +0000 Subject: [PATCH 6/6] updated readme --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 634eb91..2adbf21 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# lbr_fri_ros2_stack_doc +# lbr_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 the [lbr_fri_ros2_stack](https://github.com/lbr-stack/lbr_fri_ros2_stack). +This repository holds the documentation for the [lbr-stack](https://github.com/lbr-stack). ## Build Documentation Locally To build locally: 1. Clone this repository ```shell -git clone --recursive git@github.com:lbr-stack/lbr_fri_ros2_stack_doc.git -cd lbr_fri_ros2_stack_doc +git clone --recursive git@github.com:lbr-stack/lbr_stack_doc.git +cd lbr_stack_doc ``` 2. Clone the `lbr_fri_ros2_stack`, e.g. via (this uses [vcs](https://github.com/dirk-thomas/vcstool#how-to-install-vcstool)) @@ -39,6 +39,19 @@ python -m sphinx -T -E -b html -d _build/doctrees -D language=en . html Open and browse the documentation by opening `doc/source/html/index.html`. +## Build Paper Locally +To build the [paper](paper/paper.md) via [Docker](https://joss.readthedocs.io/en/latest/submitting.html#docker), run + +```shell +docker run --rm \ + --volume $PWD/paper:/data \ + --user $(id -u):$(id -g) \ + --env JOURNAL=joss \ + openjournals/inara +``` + +inside the `lbr_stack_doc` repository. + ## Acknowledgements wellcome