search

etternagame / etterna

Advanced cross-platform rhythm game focused on keyboard play
https://etternaonline.com/
MIT License
497 stars 135 forks source link

Add in CI workflow for generating and deploying documentation to github.io site #1222

Closed bluebandit21 closed 1 year ago

bluebandit21 commented 1 year ago

This leverages GHA to do three things: 1) Convert the markdown files under Docs/ into html using Jekyll 2) Run Doygen to automatically generate C++ documentation 3) Run LDoc to automatically generate Lua documentation

After doing so, all of the content will be hosted on etterna.github.io/etterna automagically :)

Currently, only _fallback is documented with LDoc because it's the only one actually documented right now.

9a7a41f demonstrates how to add documentation for additional files as desired, although I revert it in the following commit as Rebirth's Scripts do not actually have documentation right now and so just add clutter.

bluebandit21 commented 1 year ago

https://bluebandit21.github.io/etterna_doc_testing/ demonstrates what the content generated by this PR looks like :)

bluebandit21 commented 1 year ago

This PR has a problem that I'm unsure of the root cause of -- the Contributing.md is not actually converted into html properly by Jekyll during the Jekyll build phase. I don't have any clue why that markdown file in particular is being treated differently and the logs don't seem to say anything helpful.

bluebandit21 commented 1 year ago

This PR has a problem that I'm unsure of the root cause of -- the Contributing.md is not actually converted into html properly by Jekyll during the Jekyll build phase. I don't have any clue why that markdown file in particular is being treated differently and the logs don't seem to say anything helpful.

Fixed in ed098cb . For some reason Jekyll has to be specifically told to build that file, I don't know why but it's fixed now.