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

GZ Docs #35

Merged
merged 16 commits into from
Jul 1, 2024
Merged

GZ Docs #35

merged 16 commits into from
Jul 1, 2024

Conversation

VinDp
Copy link
Contributor

@VinDp VinDp commented Jun 24, 2024

As requested in #26, this PR adds the necessary documentation for this package, containing basic usage, customization options and limitations.
It will be followed by an additional PR for the documentation package to add it to the full documentation ecosystem.

@VinDp VinDp requested a review from fmauch June 24, 2024 13:44
Copy link
Contributor

@fmauch fmauch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also add an installation page? The README covers that already, so I would be fine with skipping it...

ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/index.rst Outdated Show resolved Hide resolved
@VinDp VinDp requested a review from fmauch June 27, 2024 15:41
ur_simulation_gz/doc/installation.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/installation.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/installation.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/usage.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/usage.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/usage.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/usage.rst Outdated Show resolved Hide resolved
ur_simulation_gz/doc/resources/ur_controllers_test.yaml Outdated Show resolved Hide resolved
ur_simulation_gz/doc/usage.rst Outdated Show resolved Hide resolved
VinDp and others added 3 commits July 1, 2024 14:16
Co-authored-by: Felix Exner (fexner) <[email protected]>
Co-authored-by: Felix Exner (fexner) <[email protected]>
@VinDp VinDp requested a review from fmauch July 1, 2024 12:44
Copy link
Contributor

@fmauch fmauch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One last formatting issue, then I think this is ready to squash-merge.

ur_simulation_gz/doc/installation.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@fmauch fmauch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good! I'll wait whether the CI gets to a sensible state before merging.


Edit: Looking at my changes from #17 we need to add building gz_ros2_control from source to the installation instructions.

@fmauch fmauch merged commit fdd121b into UniversalRobots:ros2 Jul 1, 2024
6 of 10 checks passed
@VinDp VinDp deleted the gz_documentation branch July 1, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants