Auto-build docs from master branch #2749
Closed
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Commits picked from #2658
Needs work by the maintainers to add script with tokens, etc
From the linked PR comments -
Added a commit which runs a currently non-existent
deploy_docs.shscript on Travis masterI'm not sure of how the docs are updated, but probably
mkdocs gh-deployisn't used since it erases all history on the branch.Maybe something like mkdocs/mkdocs#1082? I went for Travis instead of a Github Action since we also Sphinx in the mix to build the Python API docs
There are several other ways to write the script, just need to find one which works best
Useful blog post - https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/
Travis setup needs to be looked at