Skip to content
New issue

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

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

Already on GitHub? # to your account

deploy docs using gh-pages #15

Merged
merged 5 commits into from
Nov 29, 2020
Merged

deploy docs using gh-pages #15

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).

@TMRh20 TMRh20 merged commit cb1f771 into nRF24:master Nov 29, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants