Skip to content

Commit

Permalink
DOC Update docs for iodide code removal (#981)
Browse files Browse the repository at this point in the history
  • Loading branch information
dalcde committed Dec 31, 2020
1 parent 57fea1b commit c4548db
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 110 deletions.
8 changes: 8 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
(changelog)=
# Release notes

## Verison 0.17.0
*Unreleased*

### Breaking changes

- Removed iodide-specific code in `pyodide.js`. This breaks compatibility with
iodide.

## Version 0.16.1
*December 25, 2020*

Expand Down
8 changes: 3 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,16 +23,14 @@ The Python scientific stack, compiled to WebAssembly.
Using Pyodide
=============

Pyodide may be used in several ways, including in an Iodide notebook, directly
from JavaScript, or to execute Python scripts asynchronously in a web worker.
Although still experimental, additional packages may be installed from PyPI
to be used with Pyodide.
Pyodide may be used in several ways: directly from JavaScript, or to execute
Python scripts asynchronously in a web worker. Although still experimental,
additional packages may be installed from PyPI to be used with Pyodide.

.. toctree::
:maxdepth: 2
:caption: Usage

using_pyodide_from_iodide.md
using_pyodide_from_javascript.md
using_pyodide_from_webworker.md
serving_pyodide_packages.md
Expand Down
24 changes: 3 additions & 21 deletions docs/loading_packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,27 +55,9 @@ pyodide.loadPackage('matplotlib').then(() => {

### Installing packages from PyPI

Pyodide supports installing pure Python wheels from PyPI.

For use in Iodide:

```
%% py
import micropip
micropip.install('snowballstemmer')
# Iodide implicitly waits for the promise to resolve when the packages have finished
# installing...
%% py
import snowballstemmer
stemmer = snowballstemmer.stemmer('english')
stemmer.stemWords('go goes going gone'.split())
```

For use outside of Iodide (just Python), you can use the `then` method on the
`Promise` that {func}`micropip.install` returns to do work once the packages have
finished loading:
Pyodide supports installing pure Python wheels from PyPI with `micropip`. You
can use the `then` method on the `Promise` that {func}`micropip.install`
returns to do work once the packages have finished loading:

```py
def do_work(*args):
Expand Down
1 change: 0 additions & 1 deletion docs/type_conversions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Python to Javascript conversions occur:

- when returning the final expression from a
{ref}`pyodide.runPython <js_api_pyodide_runPython>` call
(evaluating a Python cell in Iodide)
- using {ref}`pyodide.pyimport <js_api_pyodide_pyimport>`
- passing arguments to a Javascript function from Python

Expand Down
82 changes: 0 additions & 82 deletions docs/using_pyodide_from_iodide.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/using_pyodide_from_javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Using Pyodide from Javascript

This document describes using Pyodide directly from Javascript. For information about using Pyodide from Iodide, see {ref}`using_from_iodide`.
This document describes using Pyodide directly from Javascript.

## Startup

Expand Down

0 comments on commit c4548db

Please sign in to comment.