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

CI/CD: Doxygen documentation generation #38

Open
BlastWind opened this issue Nov 13, 2021 · 1 comment
Open

CI/CD: Doxygen documentation generation #38

BlastWind opened this issue Nov 13, 2021 · 1 comment
Labels

Comments

@BlastWind
Copy link
Member

CI/CD: Continuous integration, continuous deployment.

In /docs, each person uses doxygen to build a bunch of HTML files. What if, we build a server (we have a website where anyone can go to) that builds and displays the HTML files? Then, folks don't have to install doxygen and build locally themselves and they just go to that website.

Furthermore, we can demand the server to rebuild the diagrams everytime a commit to main is detected.

This is advanced CI/CD stuff, proceed if you want to really learn about build systems and how to open source code!

@BlastWind
Copy link
Member Author

Things to look into

  1. Github actions
  2. Are there deployment (giving a server computer HTML files that the server computer hosts and displays) options from Github? If not, look into netlify, it has nice CI/CD set up with Github

Some potential helpers:
https://github.com/GDC-WM/2DGame2021/actions/new
https://stackoverflow.com/questions/61142433/automatic-c-documentation-generation-on-gitlab-project-using-doxygen

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

1 participant