nRF24 / RF24Gateway

TCP/IP (RF24Ethernet) and RF24Network Gateway
http://nRF24.github.io/RF24Gateway
GNU General Public License v2.0
48 stars 36 forks source link

deploy documentation using Github Pages #14

Closed 2bndy5 closed 3 years ago

2bndy5 commented 3 years ago

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.

  1. For this workflow to work properly, this repo's settings needs to have the "gh-pages" branch set to the Github Pages Source option: image After enabling this option, I expect the first deployment to Github Pages to render an error message.

  2. Additionally, it would less visually noisy if the "packages" & "environments" sections are hidden in the repo's sidebar settings: image

When these stipulations have been met in the repo settings I will submit a PR

TMRh20 commented 3 years ago

Done for this and: https://github.com/nRF24/RF24Mesh/issues/176 https://github.com/nRF24/RF24Ethernet/issues/19 https://github.com/nRF24/RF24Network/issues/161 https://github.com/nRF24/RF24Audio/issues/28