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

Modern documentation #525

Merged

Conversation

githubuser0xFFFF
Copy link
Contributor

This pull request adds modern documentation build target based on doxygen-awesome style

@VolkerEnderlein VolkerEnderlein merged commit b3e92d0 into coin3d:master May 3, 2024
5 checks passed
@VolkerEnderlein
Copy link
Collaborator

Thank you Uwe for the hard work you put into modernizing Coin documentation. It is highly appreciated.

@githubuser0xFFFF
Copy link
Contributor Author

Thank you for merging this. How do you distribute the documentation? I looked at the Github actions but could not find a documentation task.

@VolkerEnderlein
Copy link
Collaborator

There is no task as building the documentation has not been automated until now.

@VolkerEnderlein
Copy link
Collaborator

I just added the necessary steps to the CI to automatically build and publish the documentation for Coin and Quarter. The links on coin3d.github.io / coin3d.org point now to this awesome documentation.

@githubuser0xFFFF
Copy link
Contributor Author

githubuser0xFFFF commented May 6, 2024

Thank you Volker for adding this to CI - great. There is only a minor issue that I see on mobile devices: If I create the documentation here with doxygen 1.10.0, the hamburger menu is properly working:

grafik

In the documentation that has been compiled by CI with doxygen 1.9.1, the hamburger menu does not work and the menu eats to much space from screen:

grafik

So if it is possible in CI to use doxygen 1.10.0, then I would recommend to use this. If you do not have the time to do this, then I will look into this.

@VolkerEnderlein
Copy link
Collaborator

Thanks Uwe, I'll have a look onto the issue tonight.

@VolkerEnderlein
Copy link
Collaborator

Hi Uwe, I split the workflow into a documentation and a CI part. Then I updated the doxygen version to 1.10.0 but it needed to be compiled from source. Up to now this is done on every push. Do you know if we can cache that artifact and avoid the continuous rebuild of doxygen? Can you check whether the docs work properly on mobile devices? Cheers, Volker

@githubuser0xFFFF
Copy link
Contributor Author

Hi Volker. Documentation looks good now on mobile devices - great. I have no great experience with github workflows and don't know how to cache artifacts - sorry.

Another option is to use Ubuntu 20.04 for documentation build and just use the tarball instead of builder doxygen from source.

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

Successfully merging this pull request may close these issues.

2 participants