Skip to content

Document piplite wheel flag examples - #1949

Open
musaabhasan wants to merge 1 commit into
jupyterlite:mainfrom
musaabhasan:docs/piplite-wheel-examples
Open

musaabhasan wants to merge 1 commit into
jupyterlite:mainfrom
musaabhasan:docs/piplite-wheel-examples

Conversation

@musaabhasan

Copy link
Copy Markdown

Summary

  • Add examples for passing a single wheel with --piplite-wheels
  • Clarify that multiple wheels should be passed by repeating the flag
  • Show the equivalent PipliteAddon.piplite_urls JSON configuration
  • Add a short troubleshooting note for the string-vs-list/tuple error described in Document how to pass wheels to --piplite-wheels聽#1563

Closes #1563.

Validation

  • git diff --check
  • Checked fenced code blocks are balanced in docs/howto/pyodide/wheels.md
  • python -m sphinx.cmd.build -b html docs docs/_build/html -W --keep-going reached the changed page but did not complete in this local checkout because generated docs assets/package imports are missing (../dist, ../build/docs-app, generated API docs, and jupyterlite_core import setup). No warning was reported for the changed page.

@github-actions

github-actions Bot commented May 9, 2026

Copy link
Copy Markdown
Contributor

lite-badge 馃憟 Try it on ReadTheDocs

@posita

posita commented May 16, 2026

Copy link
Copy Markdown

Thanks for doing this!

Can a shorter version of how to use this option be included with the output of --help-all? That documentation is also currently misleading:

% jupyter lite --help-all | grep --after-context=3 piplite-wheels
--piplite-wheels=<list-item-1>...
    Local paths or URLs of piplite-compatible wheels to copy and index
    Default: []
    Equivalent to: [--PipliteAddon.piplite_urls]

This is a question for current maintainers, but in addition these long-needed documentation updates, should --piplite-wheels can be renamed to --piplite-wheel (with --piplite-wheels being kept as a deprecated synonym)? The plural version suggests it takes multiple arguments (which is the source of a lot of confusion).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to pass wheels to --piplite-wheels

2 participants