Skip to content

Fix "Try it with JupyterLite" button in user guide#470

Merged
mfisher87 merged 7 commits intogeojupyter:mainfrom
mfisher87:fix-lite-button
Feb 16, 2025
Merged

Fix "Try it with JupyterLite" button in user guide#470
mfisher87 merged 7 commits intogeojupyter:mainfrom
mfisher87:fix-lite-button

Conversation

@mfisher87
Copy link
Member

@mfisher87 mfisher87 commented Feb 15, 2025

It was a relative link but lite is installed at the root. The button on the index page works fine, but the button in the user guide doesn't work.

Replacing with /lite also doesn't work (see comments below). I switched to using the jupyterlite directive provided by jupyterlite-sphinx. Pretty sweet, but it doesn't include CSS. I opened a PR on the jupyterlite-sphinx repo to fix a constrast issue with their CSS and also ask about why the CSS wasn't bundled: jupyterlite/jupyterlite-sphinx#269


📚 Documentation preview: https://jupytergis--470.org.readthedocs.build/en/470/
💡 JupyterLite preview: https://jupytergis--470.org.readthedocs.build/en/470/lite

@mfisher87 mfisher87 added the bug Something isn't working label Feb 15, 2025
@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch mfisher87/jupytergis/fix-lite-button

@github-actions
Copy link
Contributor

github-actions bot commented Feb 15, 2025

Integration tests report: appsharing.space

@mfisher87 mfisher87 marked this pull request as draft February 15, 2025 20:16
@mfisher87
Copy link
Member Author

mfisher87 commented Feb 16, 2025

With da6ca65, the generated URL is https://jupytergis--470.org.readthedocs.build/en/470/user_guide/index.html#/lite. :( In any case, looks like the sphinx extension we're using has been capable of rendering buttons the whole time!

However, the button renders extremely inaccessibly. The white-on-yellow text is almost impossible for me to read with excellent vision ( 🤜 🪵 ). Contrast is 1.34:1 when WCAG AA guidelines specify a minimum of 4.5:1.

@mfisher87
Copy link
Member Author

mfisher87 commented Feb 16, 2025

  + zeromq                                  4.3.5  h3b0a872_7          conda-forge     335kB
  + zipp                                   3.21.0  pyhd8ed1ab_1        conda-forge      22kB
  + zstandard                              0.23.0  py312hef9b889_1     conda-forge     420kB
  + zstd                                    1.5.6  ha6fb4c9_0          conda-forge     555kB

  Summary:

  Install: 175 packages

  Total download: 96MB

──────────────────────────────────────────────────────────────────────────────────────────────


Confirm changes: [Y/n] 
Transaction starting
Unexpected error 9 on netlink descriptor 7.
Aborted (core dumped)

Weird... RTD hiccup? EDIT: Yes, re-running the build fixed it.

@mfisher87 mfisher87 closed this Feb 16, 2025
@mfisher87 mfisher87 reopened this Feb 16, 2025
@mfisher87
Copy link
Member Author

Ugh. Using the directive creates a functional button, but it looks like:

image

@mfisher87 mfisher87 marked this pull request as ready for review February 16, 2025 01:32
Copy link
Member Author

Choose a reason for hiding this comment

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

CSS copied from jupyterlite-sphinx project's docs

Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Thanks for this and the followed you opened on jupyterlite-sphinx. Looks Good to me :)

@mfisher87 mfisher87 merged commit afea4eb into geojupyter:main Feb 16, 2025
14 checks passed
@mfisher87 mfisher87 deleted the fix-lite-button branch February 16, 2025 15:21
@mfisher87
Copy link
Member Author

Thanks for the review! ❤️

HaudinFlorence pushed a commit to HaudinFlorence/jupytergis that referenced this pull request Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants