CI: Add docs build and deploy workflow #7448
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drashna
approved these changes
Nov 30, 2019
|
Thank you for your contribution! |
drashna
approved these changes
Jan 15, 2020
e827885 to
4ab09b7
Compare
Duckle29
approved these changes
Jan 29, 2020
13 tasks
943c9f5 to
5b1f163
Compare
skullydazed
reviewed
Feb 12, 2020
Erovia
approved these changes
Feb 12, 2020
|
CI changes might have to wait, or change in scope due to https://github.uint.cloudmunity/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/td-p/26869/highlight/true still being unresolved for public repos. Or I need someone with additional permissions to create/configure a token. Edit: The above is now resolved as described within the above link. Should be good to go now. |
fd8a95a to
f000163
Compare
Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com>
f000163 to
f44971c
Compare
tzarc
approved these changes
Nov 10, 2020
ChrissiQ
pushed a commit
to ChrissiQ/qmk_firmware
that referenced
this pull request
Nov 10, 2020
* Add docs build and deploy workflow * Remove old travis docs workflow * update to cli command * Tidy up for review * formatting * Update to pass style checks * Update lib/python/qmk/cli/docs.py Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Review comments - build->generate, use of verbose * Add docs * Update to match recent actions * Run within base_container * Convert cli to generate-docs * Convert cli to generate-docs - restore old file * Convert cli to generate-docs * Update docs Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
BorisTestov
pushed a commit
to BorisTestov/qmk_firmware
that referenced
this pull request
May 23, 2024
* Add docs build and deploy workflow * Remove old travis docs workflow * update to cli command * Tidy up for review * formatting * Update to pass style checks * Update lib/python/qmk/cli/docs.py Co-Authored-By: skullydazed <skullydazed@users.noreply.github.com> * Review comments - build->generate, use of verbose * Add docs * Update to match recent actions * Run within base_container * Convert cli to generate-docs * Convert cli to generate-docs - restore old file * Convert cli to generate-docs * Update docs Co-authored-by: skullydazed <skullydazed@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
It sounds like we are kinda settled on a static generator for docs pages, but not which one to use.
So to set the process going, this PR gets the docs hooked up to a gh-pages branch, and pulls out the internal docs generation from the travis workflow. Short term, this helps us migrate CI, but longer term, we largely only have to slot in a different build command at a later date.
An example output is available at https://github.com/zvecr/qmk_firmware/tree/gh-pages
Types of Changes
Checklist