jupyterlite / jupyterlite/pyodide-kernel

Add API docs

Open
#329 1 comment 1 reaction 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
90
Forks
47
Avg merge
3d 13h
Merged PRs (30d)
11

Description

### Problem

There are no API docs.

### Suggested Improvement

Add API docs for:
- Python
- `jupyterlite_pyodide_kernel` (build time)
- `pyodide_kernel` (runtime)
- `piplite`
- JS
- `@jupyterlite/pyodide-kernel`
- `@jupyterlite/pyodide-kernel-extensions`

Contributor guide

Open the contributing guide

Research direction

Start by locating the public APIs for the named Python packages `jupyterlite_pyodide_kernel`, `pyodide_kernel`, and `piplite`, then do the same for the JavaScript packages `@jupyterlite/pyodide-kernel` and `@jupyterlite/pyodide-kernel-extensions`. Done means API documentation exists for each listed package; the issue does not identify documentation files, tooling, or a required format.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.