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

Allow user to generate open-amp API Doxygen documentation in a simple way #515

Open
arnopo opened this issue Oct 12, 2023 · 2 comments
Open
Labels

Comments

@arnopo
Copy link
Collaborator

arnopo commented Oct 12, 2023

The current status is that we have 2 Doxygen configuration file:

We need to provide a simple way for contributors to generate the Doxygen API documentation, without duplicating the Doxygen configuration files.

The proposition is:

  • remove the Doxyfile in the root of the project ( merge some option in the doc/Doxygen.in)
  • add Doxygen installation instructions ( README.md and or a requirements.txt file)
  • add DOC_ONLY cmake option to be able to build Doxygen documentation in a simple way
cmake -Bbuild -DDOC_ONLY=on
make -C build doc 

@wmamills
Copy link
Collaborator

And test it on Linux Windows and macOS.
I will handle that part if you do the cmake stuff.
(I am a cmake beginner)

Copy link

This issue has been marked as a stale issue because it has been open (more than) 45 days with no activity.

@github-actions github-actions bot added the Stale label Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants