yak icon indicating copy to clipboard operation
yak copied to clipboard

Add action to generate documentation

Open schornakj opened this issue 4 years ago • 1 comments

Adds a CI action that runs when the devel branch is pushed to. The action generates HTML documentation from the project readme and headers and pushes it to this repo's gh-pages branch.

schornakj avatar Oct 25 '20 18:10 schornakj

I ran this action on a test branch on my own fork of this repo to generate a preview of the docs: https://schornakj.github.io/yak-1/doxygen/html/index.html

Couple of things to fix down the road:

  • Images in the readme don't appear in the webpage
  • It would be nice to generate a temporary test version of the docs in PRs. As currently configured the docs are only updated when the devel branch updates, i.e. when PRs are merged in.

schornakj avatar Oct 25 '20 18:10 schornakj