Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

deploy documentation using Github Pages #28

Closed
2bndy5 opened this issue Nov 28, 2020 · 4 comments · Fixed by #29
Closed

deploy documentation using Github Pages #28

2bndy5 opened this issue Nov 28, 2020 · 4 comments · Fixed by #29

Comments

@2bndy5
Copy link
Member

2bndy5 commented Nov 28, 2020

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
@2bndy5
Copy link
Member Author

2bndy5 commented Nov 28, 2020

This repo seems to need a special circumstance because there are no published releases. I could alter the workflow to deploy the docs on every commit (provided doxygen has no problems). @TMRh20 Please advise.

@TMRh20
Copy link
Member

TMRh20 commented Nov 28, 2020

Yeah, I don't expect a lot of commits, so that shouldn't be a problem.

@TMRh20 TMRh20 mentioned this issue Nov 28, 2020
Closed
@2bndy5
Copy link
Member Author

2bndy5 commented Nov 28, 2020 •
edited
Loading

I'm also going through and eliminating as many doxygen warnings as I can. I'll also add a condition to isolate these new workflows to only trigger on the master branch.

@2bndy5
Copy link
Member Author

2bndy5 commented Nov 28, 2020 •
edited
Loading

The only disadvantage to not using releases will be having to bump the PROJECT_NUMBER (in the doxyfile) for each new version of the docs.

Alternatively, I could use the commit SHA hash (first 7 alphanumeric characters -- like github displays in commit history) as a suffix to the project number, but each version bump would have to be done in the workflow file instead of the doxyfile

Example from my fork's deployment:
image

@2bndy5 2bndy5 linked a pull request Nov 29, 2020 that will close this issue
deploy docs using gh-pages #29
Merged
@TMRh20 TMRh20 closed this as completed in #29 Dec 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

deploy docs using gh-pages
2 participants
@TMRh20 @2bndy5