Skip to content

Conversation

@MicahGale
Copy link
Collaborator

@MicahGale MicahGale commented Nov 1, 2025

Pull Request Checklist for MontePy

Description

This adds jupyterlite to our website, and makes so users can run montepy demos without "installing" python.

This adds new packages:

  • jupyterlite the jupyter framework built on python webassembly
  • jupyterlite-pyodide-kernerl a python kernel built on webassembly

pyodide-kernel is only a vanilla python version, and cannot persistently install anything. Rather every instance has to install packages from wheels. Usually via %pip install <foo>. I have added making montepy wheels to the site deploy process. This is provided alongside jupyterlite and is the default installer before pypi. This ensures that there is a match between the kernel installed version, and the documented version for a given site. I also updated the demos to use %pip install montepy.

The site has jupyterlite integrated in the following ways:

  1. Added a homepage button to launch a jupyter lab instance.
  2. Added an <iframe> replite instance to the starting guide. This is essentially a web based ipython instance.
  3. Added button to the tutorials section to the jupyter lab instance.

Fixes #796


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--843.org.readthedocs.build/en/843/

@MicahGale MicahGale linked an issue Nov 1, 2025 that may be closed by this pull request
@MicahGale MicahGale added documentation Improvements or additions to documentation feature request An issue that improves the user interface. labels Nov 1, 2025
"subcommits"

Tried to move RTD to using Make

Add commands to build and copy HTML documentation

Fixed document hierarchy.

Trying oneliners?

Folders ain't there!

not oneliner?

Ensure output directory exists before copying HTML files.

I can linux

Maybe?

Sigghhh we want content.

Try using pre-build magic

Removed redundant build steps for HTML documentation.
@MicahGale MicahGale marked this pull request as ready for review November 1, 2025 20:58
@MicahGale MicahGale self-assigned this Nov 1, 2025
@MicahGale MicahGale requested a review from tjlaboss November 1, 2025 21:10
@MicahGale
Copy link
Collaborator Author

One annoying thing I dealt with is that the "file storage" is in the browser cache, and as long as the cache is valid it doesn't refresh the files from the remote. Therefore, to update the files with a change you have to delete the offline storage: https://jupyterlite.readthedocs.io/en/stable/troubleshooting.html#clear-the-browser-data

@MicahGale MicahGale mentioned this pull request Nov 3, 2025
@MicahGale MicahGale requested a review from tjlaboss November 4, 2025 17:05
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 feature request An issue that improves the user interface.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Experiment with sphinx jupyterlite

3 participants