Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Link to trifinger_docs #14

Merged
merged 2 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions doc/breathing_cat.toml
Original file line number Diff line number Diff line change
@@ -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"
7 changes: 7 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 4 additions & 1 deletion doc_mainpage.rst
Original file line number Diff line number Diff line change
@@ -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 <trifinger_docs:index>` 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.
Expand All @@ -12,6 +14,7 @@ Last rebuild of this documentation: |today|
:caption: General Documentation
:maxdepth: 1

doc/installation.rst
doc/models.rst


Expand Down
Loading