-
Notifications
You must be signed in to change notification settings - Fork 37
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
Conversation
e89d206
to
9c5ce22
Compare
@Mergifyio backport humble iron |
✅ Backports have been created
|
16aa4f1
to
441ceb1
Compare
d2e9777
to
f6c7919
Compare
There was a problem hiding this 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.
Co-authored-by: Sai Kishor Kothakota <sai.kishor@pal-robotics.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <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
* 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
* 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>
* 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>
* 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>
* 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>
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