Nuklear icon indicating copy to clipboard operation
Nuklear copied to clipboard

Update Actions to generate and deploy documentation from master branch

Open awschult002 opened this issue 1 year ago • 1 comments

based on the great work of @riri in PR #734 . i have taken things 1 step further and updated the actions to allow generation of documentation directly from the master branch. Not only does it generate from the master branch; it also does so without the need to store any HTML in the repo. no separate branches or anything.

The way it works is by github actions allowing the upload of artifacts. So, on push, the action builds the code, then builds the documentation, then uploads the html directory as an artifact.

Then the deployment action grabs the artifact and deploys that as a webpage. You can view the web page example on my repo linked here

CRITICAL: the build and deployment settings for the repo will need to be updated from source = branch to source = github action

Note: i also took a moment to fix the errors around building DOT diagrams.

awschult002 avatar Nov 18 '24 15:11 awschult002

Could we get this merged?

awschult002 avatar Jun 04 '25 00:06 awschult002