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 #162

Merged
merged 5 commits into from
Nov 29, 2020
Merged

deploy docs using gh-pages #162

merged 5 commits into from
Nov 29, 2020

Conversation

2bndy5
Copy link
Member

@2bndy5 2bndy5 commented Nov 29, 2020

Introduces a new workflow that:

  • only runs on master branch
  • only deploys docs on release "publish" or "edit" events
  • fetches latest version tag from this repo's releases and uses it to update the Doxyfile's "PROJECT_NUMBER" tag. This tag change is not committed to the Doxyfile, rather it is only used during the workflow.

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
@TMRh20 TMRh20 merged commit 4ed1a57 into nRF24:master Nov 29, 2020
@2bndy5
Copy link
Member Author

2bndy5 commented Dec 14, 2020

@TMRh20 Docs are now properly served from this repo. Could you change the link in the repo's sidebar settings?
image
should say nRF24.github.io/RF24Network (like the readme).

Same goes for RF24Ethernet

@TMRh20
Copy link
Member

TMRh20 commented Dec 14, 2020

Could you change the link in the repo's sidebar settings?

Done for all the libs

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