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

Provide Doxygen documentation #27

Closed
GiulioRomualdi opened this issue Jan 18, 2021 · 3 comments
Closed

Provide Doxygen documentation #27

GiulioRomualdi opened this issue Jan 18, 2021 · 3 comments

Comments

@GiulioRomualdi
Copy link
Member

GiulioRomualdi commented Jan 18, 2021

I've seen that the code has been documented in such a way the doxygen can be generated. It would be really nice to provide it

cc @isorrentino @S-Dafarra

@S-Dafarra
Copy link
Member

I have some preliminary results in the branch gh-pages. Then, I am wondering the following:

  • how can I have Github storing the documentation online?
  • how can I trigger the generation of the documentation every time we create a new release?

I don't know if this action can help: https://github.com/marketplace/actions/doxygen-action

cc @traversaro

@GiulioRomualdi
Copy link
Member Author

Hi @S-Dafarra

how can I have Github storing the documentation online?

https://github.com/robotology/how-to-document-modules

how can I trigger the generation of the documentation every time we create a new release?

You can Please check here: https://github.com/dic-iit/bipedal-locomotion-framework/blob/master/.github/workflows/gh-pages.yml
and here: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release

@S-Dafarra
Copy link
Member

Thanks @GiulioRomualdi for the pointers, they were extremely useful.

I have added the link to the documentation on the homepage. It should be automatically updated at every new release.

Closing.

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

No branches or pull requests

2 participants