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.

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

deploy docs using gh-pages #29

Merged
merged 18 commits into from
Dec 3, 2020
Merged

deploy docs using gh-pages #29

merged 18 commits into from
Dec 3, 2020

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Nov 29, 2020

Introduces a new workflow that:

  • only runs on master branch
  • deploys docs on any commit to master (since this repo does not use releases)
  • uses the commit's SHA hash (1st 7 alphanumeric characters -- as displayed in commit history) to append the Doxyfile's "PROJECT_NUMBER" tag with a "patch" number. This tag change is not committed to the Doxyfile, rather it is only used during the workflow. Any bump in version will now need to be done from the workflow file.

Additionally, I've

  • made fixes for all "addressable" doxygen warnings (Makefile is parsed like a C source file because there is no extension -- its a doxygen problem)
    • This includes removing deprecated tags from the Doxyfile (they were using default or invalid options anyway). I didn't use doxygen -u for backward compatibility reasons.
  • formatted and updated the doxygen-custom.css file
  • renamed all links to docs from tmrh20.github.io/<repo name> to nRF24.github.io/<repo name> except for:
  • deactivated any LATEX or XML output from doxygen since they're not actually being used (and the LATEX output seems to require 3rd party software to generate properly).

@2bndy5 2bndy5 linked an issue Nov 29, 2020 that may be closed by this pull request
@2bndy5
Copy link
Member Author

2bndy5 commented Dec 3, 2020

@TMRh20 How are the docs for this repo currently being published? I ask because I see a green checkmark next the previous commit, and there aren't any actions setup on this specific repo.

image

Is this just the result of the repo's current settings in the "source" option of the "GitHub Pages" section?

@TMRh20
Copy link
Member

TMRh20 commented Dec 3, 2020

I dunno, its still being done manually.

@TMRh20 TMRh20 merged commit 6a6c3ba into nRF24:master Dec 3, 2020
@TMRh20
Copy link
Member

TMRh20 commented Dec 3, 2020

I made a commit by editing the readme.md, but the docs don't appear to have been deployed. Any ideas or am I missing something?

@2bndy5
Copy link
Member Author

2bndy5 commented Dec 3, 2020

what are the settings for this repo concerning the "GitHub Pages" section? Can I have temporary access (like expires in a week)?
Alternatively you can email me

I see the action's workflow is executing fine, and the "gh-pages" branch looks like it should after a commit. The key ingredient is to set the "source" option to the "gh-pages" branch's root dir in the repo's settings under the "GitHub Pages" section.

@TMRh20
Copy link
Member

TMRh20 commented Dec 3, 2020

Can I have temporary access

Done. I changed the setting too.

@2bndy5
Copy link
Member Author

2bndy5 commented Dec 3, 2020

Seems like I don't need that access anymore 😆 . After you changed the settings the docs are now properly published. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

deploy documentation using Github Pages
2 participants