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

migrate and update image_proc docs #925

Merged
merged 3 commits into from
Feb 5, 2024

Conversation

mikeferguson
Copy link
Member

  • move component documentation from ros wiki, update for various changes
  • add tutorial on how to run components
  • update tutorial on debayer/rectify to use launch file
  • remove image_proc node, it has always been completely broken and the launch file has the same (but working) functionality
  • update launch file to support namespace parameter for tutorial

 * move component documentation from ros wiki, update for various changes
 * add tutorial on how to run components
 * update tutorial on debayer/rectify to use launch file
 * remove image_proc node, it has always been completely broken and the
   launch file has the same (but working) functionality
 * update launch file to support namespace parameter for tutorial
@mikeferguson
Copy link
Member Author

mikeferguson commented Feb 4, 2024

Testing done:

  • builds locally with rosdoc2
  • launch file tutorial is fully tested
    image

@mikeferguson mikeferguson mentioned this pull request Feb 5, 2024
23 tasks
Copy link
Contributor

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

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

same small comments and maybe add in the README.md the command to build the documentation ?

image_proc/doc/conf.py Outdated Show resolved Hide resolved
image_proc/doc/tutorials.rst Outdated Show resolved Hide resolved
image_proc/doc/tutorials.rst Outdated Show resolved Hide resolved
image_proc/doc/tutorials.rst Outdated Show resolved Hide resolved
image_proc/doc/tutorials.rst Outdated Show resolved Hide resolved
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
@mikeferguson
Copy link
Member Author

All great suggestions - but I'm going to skip adding build instructions to the README since we aren't doing anything fancy - just using rosdoc2 in the standard way

@mikeferguson mikeferguson merged commit 308d83f into ros-perception:rolling Feb 5, 2024
3 checks passed
@mikeferguson mikeferguson deleted the image_proc_docs branch February 5, 2024 13:37
mikeferguson added a commit that referenced this pull request Feb 5, 2024
I didn't actually rebuild with the suggestions in #925 - but this is
actually proper rendering (even my three-ticks version wasn't quite
pretty)
mikeferguson pushed a commit that referenced this pull request Feb 28, 2024
Backport pull request #925 which solves issue #952 by adding the
`namespace` parameter to the `image_proc` launch file
ahcorde pushed a commit that referenced this pull request Mar 26, 2024
Backport pull request #925 which solves issue #952 by adding the
`namespace` parameter to the `image_proc` launch file
mikeferguson pushed a commit that referenced this pull request Apr 23, 2024
Backport pull request #925 which solves issue #952 by adding the
`namespace` parameter to the `image_proc` launch file

Co-authored-by: Lucas Wendland <[email protected]>
Kotochleb pushed a commit to Kotochleb/image_pipeline that referenced this pull request May 27, 2024
* move component documentation from ros wiki, update for various changes
 * add tutorial on how to run components
 * update tutorial on debayer/rectify to use launch file
* remove image_proc node, it has always been completely broken and the
launch file has the same (but working) functionality
 * update launch file to support namespace parameter for tutorial
Kotochleb pushed a commit to Kotochleb/image_pipeline that referenced this pull request May 27, 2024
I didn't actually rebuild with the suggestions in ros-perception#925 - but this is
actually proper rendering (even my three-ticks version wasn't quite
pretty)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants