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

Update doxygen file #276

Merged
merged 2 commits into from
Jul 26, 2022
Merged

Update doxygen file #276

merged 2 commits into from
Jul 26, 2022

Conversation

chapulina
Copy link
Contributor

🦟 Bug fix

Summary

I noticed warnings like this while building on Jammy:

warning: Tag 'TCL_SUBST' at line 237 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api_tagfile.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1044 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api_tagfile.dox' has becom
e obsolete.                                                                                                                                          To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"                        
warning: Tag 'TCL_SUBST' at line 237 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api.dox' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"                        
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1044 of file '/home/chapulina/dev_jammy/ws_garden/build/gz-fuel_tools8/api.dox' has become obsole
te.                                                                                                                                         
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

How well do we want support people generating docs locally? Ultimately, what really matters are the docs we upload to https://gazebosim.org through our nightly uploads. As long as we support that use case well, I think the least we should do for other users is:

  • Document how to generate docs locally - and if that requires some specific Ubuntu version, say so
  • Don't print warnings when they build on any supported platform (for ign-cmake2 that's Bionic, Focal and Jammy).

So I ran doxygen -u doc/doxygen/api.in on Focal (which has doxygen version 1.8.17), and the file was automatically updated. I manually modified a few things that seemed to have been explicitly set by us.

My goals are to:

  • Use a newer version of doxygen to generate our docs. I think Focal makes sense, because it's supported by Citadel, Fortress and Garden. This needs to go with Generate API docs using Ubuntu Focal docs#274 and I need to test it locally.
  • Remove warnings on Jammy - this isn't addressed yet

Just opening this for visibility for now.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

Signed-off-by: Louise Poubel <[email protected]>
@chapulina chapulina added the documentation Improvements or additions to documentation label Jul 12, 2022
@github-actions github-actions bot added Gazebo 1️1️ Dependency of Gazebo classic version 11 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel labels Jul 12, 2022
@chapulina
Copy link
Contributor Author

I actually just realized that our docs don't build on Jammy for gz-sim. Commenting out ADDITIONAL_INPUT_DIRS fixes the build. Something to look into. It's probably related to the doxygen version.

@chapulina
Copy link
Contributor Author

I actually just realized that our docs don't build on Jammy for gz-sim.

Ok, I remembered now that @j-rivero had run into this, here's the issue:

@nkoenig nkoenig enabled auto-merge (squash) July 26, 2022 22:25
@nkoenig nkoenig merged commit 357fd53 into ign-cmake2 Jul 26, 2022
@nkoenig nkoenig deleted the chapulina/2/doxy_update branch July 26, 2022 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🏯 fortress Ignition Fortress Gazebo 1️1️ Dependency of Gazebo classic version 11
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants