Add GitHub Actions workflow for documentation deployment#166
Closed
xtian15 wants to merge 1 commit into
Closed
Conversation
- Create docs.yml workflow for GitHub Pages deployment - Update conf.py copyright to reflect NOAA-GFDL ownership - Preserves original AI2 attribution in copyright notice - Build triggers on push to main/develop, PR validation only Fixes #67
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.
Summary
Background
Issue #67 identified that Pace documentation is currently hosted at
ai2cm.github.io/pace/, which is controlled by AI2 and cannot be edited by the GFDL team. This PR migrates documentation hosting to the NOAA-GFDL repository's own GitHub Pages.Changes
1. New file:
.github/workflows/docs.ymlGitHub Actions workflow that:
main/developbranchesdocs/configuration2. Modified:
docs/conf.pyUpdated project metadata:
Post-Merge Setup Required
After merging, a repository admin needs to:
noaa-gfdl.github.io/Pace/Test Plan
cd docs && make html)Impact
Fixes #67