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) #270

Merged
merged 3 commits into from
Apr 16, 2024
Merged

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).

@mergify mergify bot added the conflicts label Apr 16, 2024
Copy link
Contributor Author

mergify bot commented Apr 16, 2024

Cherry-pick of 159087e has failed:

On branch mergify/bp/iron/pr-268
Your branch is up to date with 'origin/iron'.

You are currently cherry-picking commit 159087e.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   conf.py
	new file:   doc/api/api.rst

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   index.rst

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot mentioned this pull request Apr 16, 2024
@christophfroehlich
Copy link
Contributor

@Mergifyio backport humble

Copy link
Contributor Author

mergify bot commented Apr 16, 2024

backport humble

✅ Backports have been created

@christophfroehlich
Copy link
Contributor

Merging despite the failing linkcheck for control_msgs https://docs.ros.org/en/iron/p/control_msgs/

@christophfroehlich christophfroehlich merged commit 96b049e into iron Apr 16, 2024
3 of 4 checks passed
@christophfroehlich christophfroehlich deleted the mergify/bp/iron/pr-268 branch April 16, 2024 12:18
mergify bot added a commit that referenced this pull request Apr 16, 2024
* 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)
christophfroehlich pushed a commit that referenced this pull request Apr 16, 2024
* 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)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
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