ci|docs: automatic docs deployment when merging into develop#269
Merged
Conversation
7 tasks
84cc248 to
3714b84
Compare
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
This PR adds the automatic deployment of documentation from the
docs/folder to https://noaa-gfdl.github.io/NDSL with every merge into develop.@fmalatino: we might need configuration changes (in the repo settings) for this to work. It should be the same as for PyFV3, where we already automatically deploy docs to https://noaa-gfdl.github.io/PyFV3/.
@FlorianDeconinck this will deploy the whole contents of
docs/, not just the docstrings. I remember a discussion to bring some of the contents from SMT (e.g. the tutorials) over here before we publish docs. Should we do a pass at thedocs/folder first, before we deploy docs?How has this been tested?
With #268 merged, we at know that the docs will build. The deployment is untested. However, it's a standard building block and I just copied the workflow from PyFV3 where it already works. If anything fails, then it's likely a configuration issue (and I don't have access rights to check if anything needs to be configured or if things are okay).
Checklist
N/A
N/A