Merge branch 'main' into nano

Author: phorward

docs/development/maintainers.md

@@ -48,13 +48,29 @@ the latest release branch named `stable` (due to ReadTheDocs constraints).
    git push upstream stable --force
    ```
    Wait for the CI to pass and create the release on GitHub.
-6. Build the pre-built Docker image locally and push,
+6. Release the pyodide-build package,
+   ```bash
+   pip install twine build
+   cd pyodide-build/
+   python -m build .
+   ls dist/   # check the produced files
+   twine check dist/*X.Y.Z*
+   twine upload dist/*X.Y.Z*
+   ```
+7. Release the Pyodide Javascript package,
+
+   ```bash
+   cd src/js
+   npm publish
+   ```
+
+8. Build the pre-built Docker image locally and push,
    ```bash
    docker build -t pyodide/pyodide:X.Y.Z -f Dockerfile-prebuilt --build-arg VERSION=BB .
    docker push
    ```
    where `BB` is the last version of the `pyodide-env` Docker image.
-7. Revert Step 1. and increment the version in
+9. Revert Step 1. and increment the version in
    `src/py/pyodide/__init__.py` to the next version specified by
    Semantic Versioning.
 

docs/index.rst

@@ -22,7 +22,7 @@ Using Pyodide
 
    usage/quickstart.md
    usage/webworker.md
-   usage/serving-pyodide-packages.md
+   usage/downloading-and-deploying.md
    usage/loading-packages.md
    usage/type-conversions.md
    usage/wasm-constraints.md

docs/project/changelog.md

@@ -11,7 +11,9 @@ substitutions:
 
 # Change Log
 
-## [0.18.0]
+## Version 0.18.0
+
+_August 3rd, 2021_
 
 ### General
 
@@ -164,6 +166,14 @@ substitutions:
   It is optional and the current default backend is still the agg backend compiled to wasm.
 - {{ Enhancement }} Updated a number of packages included in Pyodide.
 
+### List of contributors
+
+Albertas Gimbutas, Andreas Klostermann, arfy slowy, daoxian,
+Devin Neal, fuyutarow, Grimmer, Guido Zuidhof, Gyeongjae Choi, Hood
+Chatham, Ian Clester, Itay Dafna, Jeremy Tuloup, jmsmdy, LinasNas, Madhur
+Tandon, Michael Christensen, Nicholas Bollweg, Ondřej Staněk, Paul m. p. P,
+Piet Brömmel, Roman Yurchak, stefnotch, Syrus Akbary, Teon L Brooks, Waldir
+
 ## Version 0.17.0
 
 _April 21, 2021_

docs/usage/downloading-and-deploying.md

@@ -0,0 +1,56 @@
+(downloading_deploying)=
+
+# Downloading and deploying Pyodide
+
+## Downloading Pyodide
+
+### CDN
+
+Pyodide packages, including the `pyodide.js` file, are available from the JsDelivr CDN,
+
+| channel             | indexURL                                         | Comments                                                                                 | REPL                                               |
+| ------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| Latest release      | `https://cdn.jsdelivr.net/pyodide/v0.18.0/full/` | Recommended, cached by the browser                                                       | [link](https://pyodide.org/en/stable/console.html) |
+| Dev (`main` branch) | `https://cdn.jsdelivr.net/pyodide/dev/full/`     | Re-deployed for each commit on main, no browser caching, should only be used for testing | [link](https://pyodide.org/en/latest/console.html) |
+
+To access a particular file, append the file name to `indexURL`. For instance,
+`"${indexURL}pyodide.js"` in the case of `pyodide.js`.
+
+```{warning}
+The previous CDN `pyodide-cdn2.iodide.io` is deprecated and should not be used.
+```
+
+### Github releases
+
+You can also download Pyodide packages from [Github
+releases](https://github.com/pyodide/pyodide/releases)
+(`pyodide-build-*.tar.bz2` file) serve them yourself, as explained in the
+following section.
+
+## Serving Pyodide packages
+
+If you built your Pyodide distribution or downloaded the release tarball
+you need to serve Pyodide files with appropriate headers.
+
+### Serving locally
+
+With Python 3.7.5+ you can serve Pyodide files locally by starting
+
+```
+python -m http.server
+```
+
+from the Pyodide distribution folder.
+
+Point your WebAssembly aware browser to
+[http://localhost:8000/console.html](http://localhost:8000/console.html) and open
+your browser console to see the output from Python via Pyodide!
+
+### Remote deployments
+
+Any solution that is able to host static files and correctly sets WASM
+MIME type, and CORS headers would work. For instance, you can use Github Pages
+or similar services.
+
+For additional suggestions for optimizing size and load times, see the [Emscripten
+documentation about deployments](https://emscripten.org/docs/compiling/Deploying-Pages.html).

docs/usage/quickstart.md

@@ -10,13 +10,13 @@ Try Pyodide in a [REPL](https://pyodide.org/en/latest/console.html) directly in
 
 To include Pyodide in your project you can use the following CDN URL:
 
-```{eval-rst}
-  https://cdn.jsdelivr.net/pyodide/v0.18.0/full/pyodide.js
+```text
+https://cdn.jsdelivr.net/pyodide/v0.18.0/full/pyodide.js
 ```
 
 You can also download a release from [Github
 releases](https://github.com/pyodide/pyodide/releases) or build Pyodide
-yourself. See {ref}`serving_pyodide_packages` for more details.
+yourself. See {ref}`downloading_deploying` for more details.
 
 The `pyodide.js` file defines a single async function called
 {any}`loadPyodide <globalThis.loadPyodide>` which sets up the Python environment