Skip to content

Conversation

@MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Dec 9, 2025

Pull Request Checklist for MontePy

Description

This a quick documentation fix to make the jupyterlite notebooks work. This is an issue I forgot to open. Basically piplite (the tool used by jupyterlite) installs via a background async job. So the current way of installing montepy doesn't wait for the installation to complete before trying to import montepy. This fixes this by finding the synchronous runner provided by pyodide. It maybe janky code, but it seems to work. I also went through and fixed some broken doc strings, changelog formatting errors, and all of the URLs in the Demo notebooks.

Fixes #863


General Checklist

  • I have performed a self-review of my own code.
  • The code follows the standards outlined in the development documentation.
  • I have formatted my code with black version 25.
  • I have added tests that prove my fix is effective or that my feature works (if applicable).

LLM Disclosure

Were any large language models (LLM or "AI") used in to generate any of this code?

  • Yes
    • Model(s) used:
  • No

Documentation Checklist

  • I have documented all added classes and methods.
  • For infrastructure updates, I have updated the developer's guide.
  • For significant new features, I have added a section to the getting started guide.

First-Time Contributor Checklist

  • If this is your first contribution, add yourself to pyproject.toml if you wish to do so.

Additional Notes for Reviewers

Ensure that:

  • This PR fully addresses and resolves the referenced issue(s).
  • The submitted code is consistent with the merge checklist outlined here.
  • The PR covers all relevant aspects according to the development guidelines.
  • 100% coverage of the patch is achieved, or justification for a variance is given.

📚 Documentation preview 📚: https://montepy--862.org.readthedocs.build/en/862/

@MicahGale MicahGale requested a review from tjlaboss December 9, 2025 17:00
@MicahGale MicahGale self-assigned this Dec 9, 2025
@MicahGale
Copy link
Collaborator Author

I'm thinking of doing a post release to push this to stable on RTD. Probably skip releasing on PyPI though.

@MicahGale MicahGale added the documentation Improvements or additions to documentation label Dec 9, 2025
@MicahGale
Copy link
Collaborator Author

Ok now all URLs are updated and correct.

@MicahGale
Copy link
Collaborator Author

I am going to go and merge with it being a busy time of year, and this being just for documentation, and for the existing documentation being broken.

@MicahGale MicahGale merged commit c31d5e3 into develop Dec 18, 2025
19 checks passed
@MicahGale MicahGale deleted the doc_update branch December 18, 2025 23:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update URLs in Demo notebooks

2 participants