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

Add API page (backport #268) (backport #270) #274

Merged
merged 1 commit into from
Apr 16, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Apr 16, 2024

I'd like to include the API documentation of all packages, also for the utilities like control_toolbox etc.

I see two options:

  1. Make a table and just link to docs.ros.org like here. It will be a bit more visible than now, but not searchable from control.ros.org
  2. Let rosdoc2 create the pages manually and publish a selection on control.ros.org. Advantage (or maybe also disadvantage?): Everything can be found from within a single search prompt.

The majority was for option 1 during the WG meeting on April 10th. I changed it now to a simple table:

image


This is an automatic backport of pull request #268 done by [Mergify](https://mergify.com).
This is an automatic backport of pull request #270 done by [Mergify](https://mergify.com).

* Add API page (#268)

(cherry picked from commit 159087e)

# Conflicts:
#	index.rst

* remove pid controller

* Remove merge conflicts

---------

Co-authored-by: Christoph Fröhlich <[email protected]>
(cherry picked from commit 96b049e)
@mergify mergify bot mentioned this pull request Apr 16, 2024
@christophfroehlich
Copy link
Contributor

Merging despite the broken link on http://docs.ros.org/en/humble/p/control_msgs/

@christophfroehlich christophfroehlich merged commit 480b99c into humble Apr 16, 2024
3 of 4 checks passed
@christophfroehlich christophfroehlich deleted the mergify/bp/humble/pr-270 branch April 16, 2024 12:22
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.

1 participant