-
Notifications
You must be signed in to change notification settings - Fork 0
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
Create a GitHub Action for keeping documentation up-to-date #13
Comments
As you can see from here by now on, the documentation is now build and deployed by using a dedicated GitHub Action. The Doxygen documentation is also produced from the same Action and online available from here. Note that the following are still missing parts for a full documentation production: |
The ZOO-Client API documentation is now available from here now 🎉 |
As you noticed in the various URLs provided in this issue. They contains the "ZOO-Project" repository name. I think the documentation would benefit to be accessible from URLs with "docs" in place of "ZOO-Project". For instance, this URL: https://zoo-project.github.io/ZOO-Project/C_API/index.html would become https://zoo-project.github.io/docs/C_API/index.html Also, if there is a meaning to produce doxygen documentation from the main repository in case there is any file from zoo-project/zoo-kernel that has been modified, there is no reason to update the sphinx documentation except in case the documentation itself has been modified. In consequence I would like to propose that we move the docs out of the ZOO-Project repo to a dedicated docs repository. We can also create a "docs" repository only used to publish gh-pages there and get the URLs fixed... Thanks in advance to let me know what do you think. |
I have modified the GitHub Action in such a way that it now publish the documentation on the new docs repository gh-pages branch. I hope it solve this issue. |
I think it would be a great idea to build the ZOO-Project official sphinx documentation which is available from the web site using a specific GitHub Action.
We may use GitHub Pages for such a purpose like we did in the past for publishing the workshop materials on our current infrastructure.
The text was updated successfully, but these errors were encountered: