Add Pyodide CLI documentation (pyodide#3367)

Co-authored-by: Gyeongjae Choi <def6488@gmail.com>
rsohlot · Dec 22, 2022 · fdbcc08 · fdbcc08
1 parent 8c6b0a3
commit fdbcc08
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -39,6 +39,7 @@
     "sphinxcontrib.napoleon",
     "myst_parser",
     "sphinx_js",
+    "sphinx_click",
     "autodocsumm",
     "sphinx_panels",
     "sphinx_pyodide",

diff --git a/docs/requirements-doc.txt b/docs/requirements-doc.txt
@@ -10,7 +10,10 @@ sphinx-issues==2.0.0
 sphinx-js==3.1
 sphinx-version-warning~=1.1.2
 sphinx-panels
+sphinx-click
 markupsafe<2.1.0
 pydantic
+# Packages that we want to document as part of the Pyodide CLI
+./pyodide-build/
 # Version should be consistent with packages/micropip/meta.yaml
 micropip==0.2.0
diff --git a/docs/usage/api-reference.md b/docs/usage/api-reference.md
@@ -7,5 +7,6 @@
    api/js-api.md
    api/python-api.md
    Micropip API <https://micropip.pyodide.org/en/stable/project/api.html>
+   api/pyodide-cli.md
    api/pyodide-build-cli.md
 ```
diff --git a/docs/usage/api/pyodide-build-cli.md b/docs/usage/api/pyodide-build-cli.md
@@ -2,6 +2,10 @@
 
 # pyodide-build CLI
 
+```{note}
+This CLI is being deprecated in favor of the {ref}`pyodide-cli` and will be removed in the future
+```
+
 ```{eval-rst}
 .. sphinx_argparse_cli::
    :module: pyodide_build.__main__

diff --git a/docs/usage/api/pyodide-cli.md b/docs/usage/api/pyodide-cli.md
@@ -0,0 +1,13 @@
+(pyodide-cli)=
+
+# pyodide CLI
+
+This page documents the Pyodide Command Line Interface (CLI) interface. In addition to the commands defined by `pyodide-build`, documented below, other subcommands are defined in external packages (which can be installed with pip):
+
+- `pyodide pack`, defined in [pyodide-pack](https://github.com/pyodide/pyodide-pack) is a package bundler for Pyodide
+
+```{eval-rst}
+.. click:: pyodide_cli.app:typer_click_object
+   :prog: pyodide
+   :nested: full
+```
diff --git a/pyodide-build/setup.cfg b/pyodide-build/setup.cfg
@@ -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
     cmake
     unearth~=0.6
     requests

diff --git a/requirements.txt b/requirements.txt
@@ -5,6 +5,7 @@
   pre-commit
   # testing
   build==0.7.0
+  sphinx-click
   hypothesis
   pytest
   pytest-asyncio