deploy documentation using Github Pages
Closed this issue · 1 comments
This issue is part of an effort to start hosting nRF24 org repos' docs on github per individual repo instead of uploading all RF24* lib's docs to tmrh20.github.io.
I've created a github workflow that builds the docs on every commit. This same workflow will upload the generated HTML files to the "gh-pages" branch upon publishing a new release. Notice I've already taken the liberty to create the "gh-pages" branch for this repo.
-
For this workflow to work properly, this repo's settings needs to have the "gh-pages" branch set to the Github Pages Source option:
After enabling this option, I expect the first deployment to Github Pages to render an error message. -
Additionally, it would less visually noisy if the "packages" & "environments" sections are hidden in the repo's sidebar settings:
When these stipulations have been met in the repo settings I will submit a PR
Done