Create github pages with doxygen (and css)

[scarf005]

Summary

SUMMARY: Infrastructure "Create github pages with doxygen (and css)"

Purpose of change

Found out there was an working doxyfile, so having online documentation readily available would be helpful. Of course the state of documentation is questionable but better late than never.

generated link would be https://cataclysmbnteam.github.io/Cataclysm-BN/ .

Describe the solution

Action works in following steps:

1. checkout CBN repository (or in other words, docker container running this workflow clones it)
2. check if there are cached css files.
3. if not, clone doxygen-awesome-css
4. run doxygen. generated yields are ~ 400mb.
5. deploy to github pages, in branch gh-pages.

Describe alternatives you've considered

result output is humongously large (~300mb), which might hit hard limit on file size (1GB) and monthly bandwidth(100GB).

using some of technics like this https://stackoverflow.com/a/7455621/13503626 might help reducing release size.

Testing

checked the script to run on forked repo.

Additional context

below are some of the screenshots showing how generated documentation looks like:

[Coolthulhu]

result output is humongously large (~300mb), which might hit hard limit on file size (1GB) and monthly bandwidth(100GB).

How much of it has to be downloaded to view something?
Does viewing a random page require 10+mb of downloads?

[scarf005]

deployed page on fork

network inspection says it takes around 20kb ~ 120kb per page. so sizes per each page are probably normal.

giant total size is due to it having 14000 files, mainly html, js, and png (mostly dependency graphs)

❯ ls | grep .html | wc -l
4720
❯ ls | grep .js | wc -l
2230
❯ ls | grep .png | wc -l
2926
❯ ls | wc -l
14613

page inspection result #1
page inspection result #2

[scarf005]

oh hecc still forgor to add back the actual script, will post another pr