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

API docs for the whole stack via doxygen #278

Merged
merged 27 commits into from
Apr 21, 2024
Merged

API docs for the whole stack via doxygen #278

merged 27 commits into from
Apr 21, 2024

Conversation

christophfroehlich
Copy link
Contributor

@christophfroehlich christophfroehlich commented Apr 19, 2024

Instead of running doxygen only on ros2_control repo, I implemented it now for all repositories at once.

This made some changes necessary to the helper scripts: I converted them to python scripts, because it would have been to complicated to formulate the repository-maps with bash scripts.

The doxyfile is moved over from ros2_control, but with updating it to a new doxygen version.

main page

image

example controller page

image

@christophfroehlich
Copy link
Contributor Author

@Mergifyio backport humble iron

Copy link
Contributor

mergify bot commented Apr 19, 2024

backport humble iron

✅ Backports have been created

@christophfroehlich christophfroehlich mentioned this pull request Apr 19, 2024
@christophfroehlich christophfroehlich changed the title API docs from doxygen for the whole stack API docs for the whole stack via doxygen Apr 19, 2024
@christophfroehlich christophfroehlich marked this pull request as ready for review April 20, 2024 15:27
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.

Thank you for the changes. They more or less look good to me. I left some minor comments to review.

Makefile Show resolved Hide resolved
conf.py Show resolved Hide resolved
conf.py Show resolved Hide resolved
index.rst Outdated Show resolved Hide resolved
make_help_scripts/deploy_defines.py Show resolved Hide resolved
Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
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 christophfroehlich merged commit 56c9fcb into master Apr 21, 2024
5 of 6 checks passed
@christophfroehlich christophfroehlich deleted the doxygen branch April 21, 2024 07:45
mergify bot pushed a commit that referenced this pull request Apr 21, 2024
* Use all repositories for doxygen

* Switch API also for multi-version

* Convert bash scripts to python

* Fix check_links

* Add branch_version for every repo

* Update .gitignore

* Abort only if subrepos have uncommited changes

* Checkout correct branches for multiversion-api

* Fix ci-format.yml

* Update exclude patterns

* Readd delete_sub_repos

* Add debug output

* Add pycache to gitignore

* Fix multiversion (PR) workflow

* Fix ref

* Fix ref

* Fix refs for PR workflow

* Fix add_sub_repos

* Add debug output

* Delete sub-repos at the correct time

* Try to set the correct branch also for PRs

* Fix multiversion-PR with sphinx

* Fix api_multi_version

* Add ROS version to doxygen output

* Last text updates

* Run wf only if relevant settings have changed

* Apply suggestions from code review

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

---------

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
(cherry picked from commit 56c9fcb)

# Conflicts:
#	.github/workflows/sphinx-check-page-multiversion.yml
#	conf.py
#	make_help_scripts/deploy_defines
mergify bot pushed a commit that referenced this pull request Apr 21, 2024
* Use all repositories for doxygen

* Switch API also for multi-version

* Convert bash scripts to python

* Fix check_links

* Add branch_version for every repo

* Update .gitignore

* Abort only if subrepos have uncommited changes

* Checkout correct branches for multiversion-api

* Fix ci-format.yml

* Update exclude patterns

* Readd delete_sub_repos

* Add debug output

* Add pycache to gitignore

* Fix multiversion (PR) workflow

* Fix ref

* Fix ref

* Fix refs for PR workflow

* Fix add_sub_repos

* Add debug output

* Delete sub-repos at the correct time

* Try to set the correct branch also for PRs

* Fix multiversion-PR with sphinx

* Fix api_multi_version

* Add ROS version to doxygen output

* Last text updates

* Run wf only if relevant settings have changed

* Apply suggestions from code review

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

---------

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
(cherry picked from commit 56c9fcb)

# Conflicts:
#	.github/workflows/sphinx-check-page-multiversion.yml
#	conf.py
#	make_help_scripts/deploy_defines
christophfroehlich added a commit that referenced this pull request Apr 21, 2024
* Use all repositories for doxygen

* Switch API also for multi-version

* Convert bash scripts to python

* Fix check_links

* Add branch_version for every repo

* Update .gitignore

* Abort only if subrepos have uncommited changes

* Checkout correct branches for multiversion-api

* Fix ci-format.yml

* Update exclude patterns

* Readd delete_sub_repos

* Add debug output

* Add pycache to gitignore

* Fix multiversion (PR) workflow

* Fix ref

* Fix ref

* Fix refs for PR workflow

* Fix add_sub_repos

* Add debug output

* Delete sub-repos at the correct time

* Try to set the correct branch also for PRs

* Fix multiversion-PR with sphinx

* Fix api_multi_version

* Add ROS version to doxygen output

* Last text updates

* Run wf only if relevant settings have changed

* Apply suggestions from code review

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

---------

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
christophfroehlich added a commit that referenced this pull request Apr 21, 2024
* Use all repositories for doxygen

* Switch API also for multi-version

* Convert bash scripts to python

* Fix check_links

* Add branch_version for every repo

* Update .gitignore

* Abort only if subrepos have uncommited changes

* Checkout correct branches for multiversion-api

* Fix ci-format.yml

* Update exclude patterns

* Readd delete_sub_repos

* Add debug output

* Add pycache to gitignore

* Fix multiversion (PR) workflow

* Fix ref

* Fix ref

* Fix refs for PR workflow

* Fix add_sub_repos

* Add debug output

* Delete sub-repos at the correct time

* Try to set the correct branch also for PRs

* Fix multiversion-PR with sphinx

* Fix api_multi_version

* Add ROS version to doxygen output

* Last text updates

* Run wf only if relevant settings have changed

* Apply suggestions from code review

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

---------

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
christophfroehlich added a commit that referenced this pull request Apr 21, 2024
* API docs for the whole stack via doxygen (#278)

* Use all repositories for doxygen

* Switch API also for multi-version

* Convert bash scripts to python

* Fix check_links

* Add branch_version for every repo

* Update .gitignore

* Abort only if subrepos have uncommited changes

* Checkout correct branches for multiversion-api

* Fix ci-format.yml

* Update exclude patterns

* Readd delete_sub_repos

* Add debug output

* Add pycache to gitignore

* Fix multiversion (PR) workflow

* Fix ref

* Fix ref

* Fix refs for PR workflow

* Fix add_sub_repos

* Add debug output

* Delete sub-repos at the correct time

* Try to set the correct branch also for PRs

* Fix multiversion-PR with sphinx

* Fix api_multi_version

* Add ROS version to doxygen output

* Last text updates

* Run wf only if relevant settings have changed

* Apply suggestions from code review

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

---------

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

* Fix deploy defines for humble

---------

Co-authored-by: Christoph Fröhlich <christophfroehlich@users.noreply.github.com>
Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
Co-authored-by: Christoph Froehlich <christoph.froehlich@ait.ac.at>
christophfroehlich added a commit that referenced this pull request Apr 21, 2024
* API docs for the whole stack via doxygen (#278)

* Use all repositories for doxygen

* Switch API also for multi-version

* Convert bash scripts to python

* Fix check_links

* Add branch_version for every repo

* Update .gitignore

* Abort only if subrepos have uncommited changes

* Checkout correct branches for multiversion-api

* Fix ci-format.yml

* Update exclude patterns

* Readd delete_sub_repos

* Add debug output

* Add pycache to gitignore

* Fix multiversion (PR) workflow

* Fix ref

* Fix ref

* Fix refs for PR workflow

* Fix add_sub_repos

* Add debug output

* Delete sub-repos at the correct time

* Try to set the correct branch also for PRs

* Fix multiversion-PR with sphinx

* Fix api_multi_version

* Add ROS version to doxygen output

* Last text updates

* Run wf only if relevant settings have changed

* Apply suggestions from code review

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

---------

Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>

* Fix deploy defines for iron

* Fix deploy defines for iron

---------

Co-authored-by: Christoph Fröhlich <christophfroehlich@users.noreply.github.com>
Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
Co-authored-by: Christoph Froehlich <christoph.froehlich@ait.ac.at>
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