Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enable eamxx docs + add pyscream docs #6748

Merged
merged 4 commits into from
Nov 15, 2024
Merged

Conversation

mahf708
Copy link
Contributor

@mahf708 mahf708 commented Nov 14, 2024

Enables building eamxx docs on E3SM repo; adds pyscream prelim docs as well.
Add content to eamxx user and dev guide main pages.

@mahf708 mahf708 added Documentation EAMxx PRs focused on capabilities for EAMxx labels Nov 14, 2024
Copy link

github-actions bot commented Nov 14, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://E3SM-Project.github.io/E3SM/pr-preview/pr-6748/
on branch gh-pages at 2024-11-14 23:34 UTC

Copy link
Contributor

@bartgol bartgol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe the eamxx-gh-pages action should be updated to actually be the E3SM mkdocs action? Meaning, change the name, and check paths for ALL yml/md files and folders that can impact gh-pages for the whole project?

@mahf708
Copy link
Contributor Author

mahf708 commented Nov 14, 2024

Maybe the eamxx-gh-pages action should be updated to actually be the E3SM mkdocs action? Meaning, change the name, and check paths for ALL yml/md files and folders that can impact gh-pages for the whole project?

The e3sm-gh-pages action already does it all; note the shiny new EAMxx section here: https://docs.e3sm.org/E3SM/pr-preview/pr-6748/EAMxx/

We will remove the eamxx-gh-page action once we freeze the scream repo

@bartgol
Copy link
Contributor

bartgol commented Nov 14, 2024

Ah, I quickly glanced at the folder and missed the e3sm-gh-pages file. Well, then follow up: why do we need two actions in this repo? Can't we just rm the eamxx one right now?

@mahf708
Copy link
Contributor Author

mahf708 commented Nov 14, 2024

Ah, I quickly glanced at the folder and missed the e3sm-gh-pages file. Well, then follow up: why do we need two actions in this repo? Can't we just rm the eamxx one right now?

We run the eamxx one in scream repo. The scream docs (docs.e3sm.org/scream) have all been generated from the eamxx-gh-pages action. The E3SM docs (docs.e3sm.org/e3sm) have all been generated from the e3sm-gh-pages action. We had two because we started the scream one before and it was "unsupported" so it was easier to just keep it separate

I updated the eamxx-gh-pages one here in case we do e3sm->scream sync between now and the freeze

@mahf708
Copy link
Contributor Author

mahf708 commented Nov 14, 2024

@rljacob could we please integrate this? We need it for the newsletter release. I assigned you as FYI, so please feel free to reassign someone else, thanks :)

Fix some typos. Add links to the otherwise blank user and developer guide
main pages.  Also change SCREAM to EAMxx in those.
rljacob added a commit that referenced this pull request Nov 15, 2024
Enables building eamxx docs on E3SM repo; adds pyscream prelim docs as well.
Add content to eamxx user and dev guide main pages.
@rljacob rljacob merged commit 5892bb3 into master Nov 15, 2024
18 of 29 checks passed
@rljacob rljacob deleted the mahf708/eamxx/pyscream-docs branch November 15, 2024 04:31
@mahf708
Copy link
Contributor Author

mahf708 commented Nov 15, 2024

Thanks, @rljacob for the edits and the merge 💌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation EAMxx PRs focused on capabilities for EAMxx
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants