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 (backport #278) #285

Merged
merged 3 commits into from
Apr 21, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Apr 21, 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


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

Copy link
Contributor Author

mergify bot commented Apr 21, 2024

Cherry-pick of 56c9fcb has failed:

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

You are currently cherry-picking commit 56c9fcb.
  (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:   .github/workflows/ci-format.yml
	modified:   .gitignore
	modified:   Makefile
	modified:   doc/api_list/api_list.rst
	modified:   doc/api_list/mainpage.md
	modified:   index.rst
	deleted:    make_help_scripts/add_pr_stats
	new file:   make_help_scripts/add_pr_stats.py
	deleted:    make_help_scripts/add_sub_repos
	new file:   make_help_scripts/add_sub_repos.py
	deleted:    make_help_scripts/add_tmp_commits
	new file:   make_help_scripts/add_tmp_commits.py
	deleted:    make_help_scripts/check_links
	new file:   make_help_scripts/check_links.py
	deleted:    make_help_scripts/create_api
	new file:   make_help_scripts/create_api.py
	deleted:    make_help_scripts/create_api_multi_version
	new file:   make_help_scripts/create_api_multi_version.py
	modified:   make_help_scripts/create_pr_stats.py
	deleted:    make_help_scripts/delete_sub_repos
	new file:   make_help_scripts/delete_sub_repos.py
	deleted:    make_help_scripts/delete_tmp_commits
	new file:   make_help_scripts/delete_tmp_commits.py
	new file:   make_help_scripts/deploy_defines.py

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	deleted by us:   .github/workflows/sphinx-check-page-multiversion.yml
	both modified:   conf.py
	deleted by them: make_help_scripts/deploy_defines

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

* 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 <[email protected]>

---------

Co-authored-by: Sai Kishor Kothakota <[email protected]>
@christophfroehlich christophfroehlich merged commit acc513d into iron Apr 21, 2024
3 of 4 checks passed
@christophfroehlich christophfroehlich deleted the mergify/bp/iron/pr-278 branch April 21, 2024 09:15
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