Skip to content

Conversation

@altheaden
Copy link
Collaborator

@altheaden altheaden commented Jun 11, 2025

This PR switches the documentation workflows for MPAS-Analysis to use sphinx with @xylar's custom version switcher instead of using sphinx-multiversion.

Checklist

  • Documentation has been built locally and changes look as expected
  • Testing comment in the PR documents testing used to verify the changes

@altheaden altheaden added documenation dependencies ci Changes that affect github actions CI labels Jun 11, 2025
@xylar
Copy link
Collaborator

xylar commented Jun 11, 2025

@xylar
Copy link
Collaborator

xylar commented Jun 11, 2025

I think we're still missing changes from:
https://github.com/E3SM-Project/polaris/pull/308/files

I'm seeing docs/_templates/layout.html that is missing here. Please check if there are any other changes that didn't make the port over.

@xylar
Copy link
Collaborator

xylar commented Jun 12, 2025

@altheaden, one more place that needs updating:

cd docs
make clean
make html

@altheaden
Copy link
Collaborator Author

@xylar I think the missing files and other issues you noticed have been fixed now. Can you take another look when you get a chance?

Copy link
Collaborator

@xylar xylar left a comment

Choose a reason for hiding this comment

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

@altheaden, we're almost there! Just a few more small changes are needed. With these, I was able to run the developer test suite and get a version of the documentation with the dropdown:
https://web.lcrc.anl.gov/public/e3sm/diagnostic_output/ac.xylar/analysis_testing/chrysalis/version-dropdown/docs/test/

@altheaden
Copy link
Collaborator Author

@xylar I fixed those issues and located one more place where things needed updating. Does everything look okay to you?

@xylar
Copy link
Collaborator

xylar commented Jun 17, 2025

Ah, great! Thanks for finding the tutorial as well!

I was tempted to just merge but I think I should run the test suite with the latest changes to make sure everything works. I'll report back soon.

Copy link
Collaborator

@xylar xylar left a comment

Choose a reason for hiding this comment

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

@xylar xylar merged commit 75cca38 into MPAS-Dev:develop Jun 17, 2025
5 checks passed
@altheaden altheaden deleted the version-dropdown branch June 17, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Changes that affect github actions CI dependencies documenation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants