Switch to using the deploy_sphinx_docs_multiversion action #78
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
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
What is this PR
Why is this PR needed?
We currently use a messy workflow for publishing docs for multiple versions of NeuroBlueprint, as well as a "dev" version.
@animeshsasan has kindly turned that prototype into a reusable action, see neuroinformatics-unit/actions#93
What does this PR do?
Switches from our messy prototype to using the re-usable action, called
deploy_sphinx_docs_multiversion.References
neuroinformatics-unit/actions#91
neuroinformatics-unit/actions#93
neuroinformatics-unit/movement#668
How has this PR been tested?
During neuroinformatics-unit/actions#93 @animeshsasan tested this new action on several forks. See that PR for details.
Is this a breaking change?
No. In theory, this should all work out fine for the next release and previous versions should be preserved.
Does this PR require an update to the documentation?
No. I've updated the comment at the top of the yaml workflow to reflect the new behaviour.
Checklist: