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

Update doc build to py313 #2050

Merged
merged 18 commits into from
Feb 6, 2025
Merged

Update doc build to py313 #2050

merged 18 commits into from
Feb 6, 2025

Conversation

opotowsky
Copy link
Member

@opotowsky opotowsky commented Jan 10, 2025

What is the change?

The docs are being built with python 3.9. This updates them to python 3.13 (updating dependency pins in the process)

Why is the change being made?

Keepin' up with the times!


Checklist

  • The release notes have been updated if necessary.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in pyproject.toml.

@opotowsky opotowsky added documentation Improvements or additions to documentation ci Related to continuous integration / github actions labels Jan 10, 2025
@opotowsky opotowsky linked an issue Jan 10, 2025 that may be closed by this pull request
doc/conf.py Show resolved Hide resolved
doc/conf.py Show resolved Hide resolved
@john-science john-science marked this pull request as draft January 14, 2025 18:14
@ntouran
Copy link
Member

ntouran commented Jan 31, 2025

was just talking to @john-science about the nbextensions. That's from back when we had an awesome dockerized jupyterhub instance of ARMI with all plugins. It added a few neat tools that some users liked. It's totally fine to remove it now since we don't know of anyone using them in jupyterhub at the moment.

@john-science john-science marked this pull request as ready for review January 31, 2025 23:29
@john-science
Copy link
Member

Okay, so I opened the docs your PR generates: https://github.com/terrapower/armi/actions/runs/13082534763?pr=2050

Almost everything is working, and looks great.

But the "Gallery" section is broken:

image

There are no links to the generated pages. I downloaded another PRs recently generated docs and they did not have this problem.

@ntouran Could this be the dependency we dropped?

pyproject.toml Outdated Show resolved Hide resolved
@john-science john-science self-requested a review February 3, 2025 19:46
@john-science
Copy link
Member

Do we know what happened to the Gallery yet? Was that the dependency we removed?

@opotowsky
Copy link
Member Author

Do we know what happened to the Gallery yet? Was that the dependency we removed?

I haven't been researching this. I probably can't take a stab until next week given other priorities, though 😥

@ntouran
Copy link
Member

ntouran commented Feb 6, 2025

I can look into the gallery issue. I don't think it can be related to jupyter-contrib-nbextensions but it's something else.

These fixes were all informed by the sphinx warnings during build.
The labels weren't being applied correctly in the gallery and made
it look bad. Looks good now.
@ntouran
Copy link
Member

ntouran commented Feb 6, 2025

last commit from me fixes it :)
image

Copy link
Member

@john-science john-science left a comment

Choose a reason for hiding this comment

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

Okay, I reviewed the output HTML and I think it looks good.

https://github.com/terrapower/armi/actions/runs/13185181566?pr=2050

@opotowsky opotowsky merged commit f1557a0 into main Feb 6, 2025
17 checks passed
@opotowsky opotowsky deleted the docs-to-py313 branch February 6, 2025 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Related to continuous integration / github actions documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update ARMI docs to Python 3.13
3 participants