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 #268

Merged
merged 5 commits into from
Apr 16, 2024
Merged

Add API page #268

merged 5 commits into from
Apr 16, 2024

Conversation

christophfroehlich
Copy link
Contributor

@christophfroehlich christophfroehlich commented Apr 10, 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

@christophfroehlich christophfroehlich marked this pull request as ready for review April 13, 2024 19:52
Copy link
Member

@saikishor saikishor left a comment

Choose a reason for hiding this comment

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

LGTM

@christophfroehlich
Copy link
Contributor Author

@Mergifyio backport humble iron

Copy link
Contributor

mergify bot commented Apr 16, 2024

backport humble iron

✅ Backports have been created

@christophfroehlich christophfroehlich merged commit 159087e into master Apr 16, 2024
5 checks passed
mergify bot pushed a commit that referenced this pull request Apr 16, 2024
(cherry picked from commit 159087e)

# Conflicts:
#	index.rst
@mergify mergify bot mentioned this pull request Apr 16, 2024
mergify bot pushed a commit that referenced this pull request Apr 16, 2024
(cherry picked from commit 159087e)

# Conflicts:
#	index.rst
@mergify mergify bot mentioned this pull request Apr 16, 2024
@christophfroehlich christophfroehlich deleted the add_api branch April 16, 2024 07:21
christophfroehlich added a commit that referenced this pull request Apr 16, 2024
(cherry picked from commit 159087e)

# Conflicts:
#	index.rst
christophfroehlich 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]>
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.

2 participants