API docs for the whole stack via doxygen #278

christophfroehlich · 2024-04-19T21:56:08Z

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

example controller page

christophfroehlich · 2024-04-19T22:27:55Z

@Mergifyio backport humble iron

mergify · 2024-04-19T22:28:10Z

backport humble iron

✅ Backports have been created

#284 API docs for the whole stack via doxygen (backport #278) has been created for branch humble but encountered conflicts
#285 API docs for the whole stack via doxygen (backport #278) has been created for branch iron but encountered conflicts

saikishor

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

.github/workflows/sphinx-check-page-multiversion.yml

Makefile

conf.py

index.rst

make_help_scripts/deploy_defines.py

conf.py

Co-authored-by: Sai Kishor Kothakota <[email protected]>

saikishor

LGTM

* 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]> (cherry picked from commit 56c9fcb) # Conflicts: # .github/workflows/sphinx-check-page-multiversion.yml # conf.py # make_help_scripts/deploy_defines

* 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]>

* 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 <[email protected]> --------- Co-authored-by: Sai Kishor Kothakota <[email protected]> * Fix deploy defines for humble --------- Co-authored-by: Christoph Fröhlich <[email protected]> Co-authored-by: Sai Kishor Kothakota <[email protected]> Co-authored-by: Christoph Froehlich <[email protected]>

* 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 <[email protected]> --------- Co-authored-by: Sai Kishor Kothakota <[email protected]> * Fix deploy defines for iron * Fix deploy defines for iron --------- Co-authored-by: Christoph Fröhlich <[email protected]> Co-authored-by: Sai Kishor Kothakota <[email protected]> Co-authored-by: Christoph Froehlich <[email protected]>

christophfroehlich force-pushed the doxygen branch from e89d206 to 9c5ce22 Compare April 19, 2024 22:04

christophfroehlich mentioned this pull request Apr 19, 2024

Add doxyfile #279

Merged

christophfroehlich changed the title ~~API docs from doxygen for the whole stack~~ API docs for the whole stack via doxygen Apr 19, 2024

This was referenced Apr 20, 2024

Add doxyfile (backport #279) #280

Merged

Add doxyfile (backport #279) #281

Merged

Add doxyfile (backport #279) #282

Merged

Add doxyfile (backport #279) #283

Merged

christophfroehlich added 17 commits April 20, 2024 11:02

Use all repositories for doxygen

d71f3cf

Switch API also for multi-version

4946910

Convert bash scripts to python

f7e91f0

Fix check_links

331d285

Add branch_version for every repo

89fefaf

Update .gitignore

17a6747

Abort only if subrepos have uncommited changes

ff5c446

Checkout correct branches for multiversion-api

8b3c847

Fix ci-format.yml

b021c3b

Update exclude patterns

e381fa5

Readd delete_sub_repos

06f41f8

Add debug output

6682920

Add pycache to gitignore

77adae0

Fix multiversion (PR) workflow

78ceba4

Fix ref

77391fc

Fix ref

54bf3bc

Fix refs for PR workflow

441ceb1

christophfroehlich force-pushed the doxygen branch from 16aa4f1 to 441ceb1 Compare April 20, 2024 11:02

christophfroehlich added 3 commits April 20, 2024 13:18

Fix add_sub_repos

9617e27

Add debug output

f319390

Delete sub-repos at the correct time

7912e78

christophfroehlich added 3 commits April 20, 2024 14:02

Try to set the correct branch also for PRs

f452f5c

Fix multiversion-PR with sphinx

53149b4

Fix api_multi_version

f6c7919

christophfroehlich force-pushed the doxygen branch from d2e9777 to f6c7919 Compare April 20, 2024 14:44

christophfroehlich added 2 commits April 20, 2024 15:16

Add ROS version to doxygen output

bbb654c

Last text updates

d25d895

christophfroehlich marked this pull request as ready for review April 20, 2024 15:27

christophfroehlich requested review from fmauch and saikishor April 20, 2024 15:27

Run wf only if relevant settings have changed

6709e57

saikishor requested changes Apr 20, 2024

View reviewed changes

christophfroehlich commented Apr 20, 2024

View reviewed changes

conf.py Show resolved Hide resolved

Apply suggestions from code review

8b356e2

Co-authored-by: Sai Kishor Kothakota <[email protected]>

christophfroehlich requested a review from saikishor April 20, 2024 19:22

This was referenced Apr 20, 2024

Add custom rosdoc2 config for ros2_control metapackage ros-controls/ros2_control#1484

Merged

Let's add a bit of documentation ros-controls/control_toolbox#154

Open

saikishor approved these changes Apr 20, 2024

View reviewed changes

christophfroehlich merged commit 56c9fcb into master Apr 21, 2024
5 of 6 checks passed

christophfroehlich deleted the doxygen branch April 21, 2024 07:45

mergify bot mentioned this pull request Apr 21, 2024

API docs for the whole stack via doxygen (backport #278) #284

Merged

mergify bot mentioned this pull request Apr 21, 2024

API docs for the whole stack via doxygen (backport #278) #285

Merged

This was referenced Jun 25, 2024

Add custom rosdoc2 config for ros2_control metapackage (backport #1484) ros-controls/ros2_control#1588

Draft

Add custom rosdoc2 config for ros2_control metapackage (backport #1484) ros-controls/ros2_control#1589

Draft

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

API docs for the whole stack via doxygen #278

API docs for the whole stack via doxygen #278

christophfroehlich commented Apr 19, 2024 •

edited

Loading

christophfroehlich commented Apr 19, 2024

mergify bot commented Apr 19, 2024 •

edited

Loading

saikishor left a comment

saikishor left a comment

API docs for the whole stack via doxygen #278

API docs for the whole stack via doxygen #278

Conversation

christophfroehlich commented Apr 19, 2024 • edited Loading

main page

example controller page

christophfroehlich commented Apr 19, 2024

mergify bot commented Apr 19, 2024 • edited Loading

✅ Backports have been created

saikishor left a comment

Choose a reason for hiding this comment

saikishor left a comment

Choose a reason for hiding this comment

christophfroehlich commented Apr 19, 2024 •

edited

Loading

mergify bot commented Apr 19, 2024 •

edited

Loading