Skip to content

FIX Jupyterlite in CircleCI artifact #1336

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

Merged

Conversation

lesteve
Copy link
Member

@lesteve lesteve commented Jun 22, 2024

A while ago, there was some CircleCI limitation that prevented JupyterLite to work inside CircleCI artifact, see #977 (comment) if you are really curious.

It seems something has changed now, but for some reason you need to be explicit and add index.html to the URL, don't ask me why ... edit: I found this very old discussion from 2015 but nothing more recent.

Let's try this in this PR!

An example of a recent scikit-learn doc build CircleCI artifact example

The JupyterLite link points to https://output.circle-artifacts.com/output/job/13caab71-1b1d-444a-b316-93ac215ec6ef/artifacts/0/doc/lite/lab/?path=auto_examples/release_highlights/plot_release_highlights_1_5_0.ipynb which shows
image

Add index.html i.e. lite/lab/index.html?path=... instead of lite/lab/?path=... and now it works:
https://output.circle-artifacts.com/output/job/13caab71-1b1d-444a-b316-93ac215ec6ef/artifacts/0/doc/lite/lab/index.html?path=auto_examples/release_highlights/plot_release_highlights_1_5_0.ipynb

@lesteve
Copy link
Member Author

lesteve commented Jun 22, 2024

Yup seems to work: see JupyterLite link on this PR example

Compare this to the same example for the CircleCI build on the master branch which shows the message not found thing when you click on the JupyterLite link.

Copy link
Contributor

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

Thanks!

@larsoner larsoner merged commit b82bba0 into sphinx-gallery:master Jun 22, 2024
19 checks passed
@larsoner
Copy link
Contributor

Thanks @lesteve !

larsoner added a commit to jschueller/sphinx-gallery that referenced this pull request Jun 22, 2024
* upstream/master:
  MNT: Sort imports and add to pre commit (sphinx-gallery#1337)
  FIX Jupyterlite in CircleCI artifact (sphinx-gallery#1336)
@lesteve lesteve deleted the fix-jupyterlite-circleci-artifact branch June 23, 2024 04:28
clrpackages referenced this pull request in clearlinux-pkgs/pypi-sphinx_gallery Jul 23, 2024
… to version 0.17.0

v0.17.0
-------

Support for Python 3.8 and Sphinx 4 dropped in this release.
Requirement is now Python >= 3.9 and Sphinx >= 5.

**Implemented enhancements:**

-  Introduction tooltip corresponds to the first paragraph `#1344 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1344>`__ (`fgmacedo <https://github.com/fgmacedo>`__)
-  FIX Jupyterlite in CircleCI artifact `#1336 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1336>`__ (`lesteve <https://github.com/lesteve>`__)
-  MNT: Rename README.rst to GALLERY_HEADER.rst `#1321 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1321>`__ (`timhoffm <https://github.com/timhoffm>`__)
-  [ENH] Add custom thumbnails for failing examples `#1313 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1313>`__ (`tsbinns <https://github.com/tsbinns>`__)
-  ENH integrate download/launcher links into ``pydata-sphinx-theme`` secondary sidebar `#1312 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1312>`__ (`Charlie-XIAO <https://github.com/Charlie-XIAO>`__)
-  add option for zip downloads `#1299 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1299>`__ (`jamiecook <https://github.com/jamiecook>`__)
-  Allow setting animation format from gallery config `#1243 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1243>`__ (`QuLogic <https://github.com/QuLogic>`__)

(NEWS truncated at 15 lines)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants