From e543c6b37ebde419d3bb32d8fc374f259b3bb4c5 Mon Sep 17 00:00:00 2001 From: Felix Kloss Date: Thu, 14 Dec 2023 16:42:32 +0100 Subject: [PATCH 1/2] doc: Link to trifinger_docs Add a page with installation instructions that simply links to trifinger_docs. --- doc/breathing_cat.toml | 3 +++ doc/installation.rst | 7 +++++++ doc_mainpage.rst | 5 ++++- 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 doc/installation.rst diff --git a/doc/breathing_cat.toml b/doc/breathing_cat.toml index 3517851..f8d8d70 100644 --- a/doc/breathing_cat.toml +++ b/doc/breathing_cat.toml @@ -1,3 +1,6 @@ [mainpage] title = "robot_properties_fingers: Models of the (Tri-)Finger Robots" auto_general_docs = false + +[intersphinx.mapping] +trifinger_docs = "https://open-dynamic-robot-initiative.github.io/trifinger_docs" diff --git a/doc/installation.rst b/doc/installation.rst new file mode 100644 index 0000000..9d5a453 --- /dev/null +++ b/doc/installation.rst @@ -0,0 +1,7 @@ +************ +Installation +************ + +The ``robot_properties_fingers`` package is part of the TriFinger software +bundle. See :ref:`trifinger_docs:install_software` in the TriFinger +documentation. diff --git a/doc_mainpage.rst b/doc_mainpage.rst index fe1149e..10bab24 100644 --- a/doc_mainpage.rst +++ b/doc_mainpage.rst @@ -1,5 +1,7 @@ ``robot_properties_fingers`` contains the xacro model files for the various -(Tri-)Finger robots as well as some Python utils to work with them. +:doc:`(Tri-)Finger robots ` as well as some Python utils +to work with them. + The source code is hosted on GitHub_. Please also use the `Bug Tracker`_ there if you have a question or want to report a bug. @@ -12,6 +14,7 @@ Last rebuild of this documentation: |today| :caption: General Documentation :maxdepth: 1 + doc/installation.rst doc/models.rst From e9eeb60fd3e7d6c7039b27652dc42a017c5297e7 Mon Sep 17 00:00:00 2001 From: Felix Kloss Date: Thu, 14 Dec 2023 16:45:11 +0100 Subject: [PATCH 2/2] chore: Fix ruff workflow --- .github/workflows/lint.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 763562e..727a120 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -31,9 +31,9 @@ jobs: run: | python -m pip install --upgrade pip python -m pip install ruff - # Include `--format=github` to enable automatic inline annotations. + # Include `--output-format=github` to enable automatic inline annotations. - name: Run Ruff - run: ruff check --format=github . + run: ruff check --output-format=github . black: name: Python Formatting