Add Pyodide CLI documentation #3367
Conversation
rth
changed the title
Though actually since emscripten-auditwheel is now a dependency of pyodide-build it means it will be installed and auto-documented here. This still raises the question of how to manage its version and that we should be more explicit about where each command is defined in. |
|
OK, to fix CI we would need to merge pyodide/pyodide-cli#17 and make a |
|
There are some minimal docs on virtual environments here: |
Hmm, probably we need to find a way to "not" auto-document those packages. |
rth
changed the title
|
RTD CI failure due to #3375 but otherwise this is ready. You can see the last working build in https://pyodide--3367.org.readthedocs.build/en/3367/ before I merged with main which introduced the failure.
If the users see these commands when they install pyodide-build it's also a bit strange not to document them. I was thinking we could maybe just improve the CLI subcommand docs as to where a given subcommand is defined pyodide/pyodide-cli#18 but this could also be done later. |
|
Can anyone review, please? It's one one of the few remaining blockers for v0.22 #3340 |
There was a problem hiding this comment.
Thanks, @rth! and sorry for the slow feedback. I have some minor comments otherwise LGTM.
| markupsafe<2.1.0 | ||
| pydantic | ||
| pyodide-cli~=0.2.1 | ||
| # Packages that we want to document as part of the Pyodide CLI | ||
| ./pyodide-build/ |
There was a problem hiding this comment.
Do we need to specify both pyodide-cli and pyodide-build here? I guess installing pyodide-build will install the proper version of pyodide-cli.
There was a problem hiding this comment.
Good point. Removed. Thanks for the review!
| @@ -29,7 +29,7 @@ install_requires = | |||
| build==0.7.0 | |||
| virtualenv | |||
| pydantic>=1.10.2 | |||
| pyodide-cli>=0.2.0 | |||
| pyodide-cli~=0.2.1 | |||
There was a problem hiding this comment.
Probably let's release pyodide-cli 0.2.2 including #20. We can also update auditwheel-emscripten to 0.0.9 which renamed the entrypoint to pyodide auditwheel.
There was a problem hiding this comment.
Agreed. ~=0.2.1 is equivalent to >=0.2.1,<0.3.0 so we can still merge this and it will use the latest versions once those releases are made.
Co-authored-by: Gyeongjae Choi <def6488@gmail.com>
This adds an auto-generate section about the Pyodide CLI.
Requires pyodide/pyodide-cli#17. There is no typer plugin for sphinx, so we have to use sphinx-click (since typer is a wrapper around click it's not an issue).
The question is what we should do about other packages that register subcommands in the Pyodide CLI (e.g. emscripten-auditwheel, pyodide-pack etc):
docs/requirements-doc.txtand the corresponding CLI docs are generated. But then,About
pyodide venvwe need to document it in a separate PR, tag it as experimental, and explain the current limitations. Probably the command description needs updating, but maybe also add a section somewhere in "How to use Pyodide".Also opened a few issues in https://github.com/ryanking13/auditwheel-emscripten/issues related to this.