Skip to content

Commit

Permalink
update more versions, links, style
Browse files Browse the repository at this point in the history
  • Loading branch information
bollwyvl committed Oct 27, 2023
1 parent 40cd63c commit c24affc
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build:
os: ubuntu-22.04
tools:
python: '3.11'
nodejs: '18'
nodejs: '20'
apt_packages:
- libarchive-dev

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The final, user-facing products of `jupyterlite-pyodide-kernel` are:

- the [distribution](#distributions) on `pyp.org` and `npmjs.org`
- the [distribution](#distributions) on `pypi.org` and `npmjs.org`
- the [documentation](#documentation) on ReadTheDocs

Preparing for a [release], however, requires a number of intermediate steps.
Expand All @@ -18,7 +18,7 @@ and watch what it does to files on disk and in the terminal log.

- `git`
- `python >=3.8`
- `nodejs >=18,<19`
- `nodejs >=20,<21`

### Setup

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@

### Compatibility

| status | `jupyterlite-pyodide-kernel` | `jupyterlite-core` | `jupyterlab` | `notebook` | `retrolab` |
| :----: | :--------------------------: | :----------------: | :----------: | :--------: | :--------: |
| stable | `0.2.*` | `0.2.*` | `4.0.*` | `7.0.*` | - |
| stable | `0.1.*` | `0.1.*` | `3.5.*` | - | `0.3.*` |
| status | `jupyterlite-pyodide-kernel` | `jupyterlite-core` | `jupyterlab` | `notebook` | `retrolab` |
| :----: | :--------------------------: | :----------------: | :----------: | :----------: | :----------: |
| stable | `0.2.*` | `>=0.2,<0.3` | `>=4.0.7,<5` | `>=7.0.5,<8` | - |
| stable | `0.1.*` | `>=0.1,<0.2` | `>=3.5,<3.6` | - | `>=0.3,<0.4` |

Installing the matching version of JupyterLab with your package manager can help ensure
matching labextension assets and kernel dependencies, even though this kernel does not
Expand Down
3 changes: 3 additions & 0 deletions docs/_static/variables.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.table {
--bs-table-bg: transparent;
}
26 changes: 12 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,20 @@

# theme
html_theme = "pydata_sphinx_theme"
html_logo = "../packages/pyodide-kernel-extension/style/img/pyodide.svg"
html_favicon = html_logo
html_theme_options = {
"github_url": P["urls"]["Source"],
"use_edit_page_button": True,
"icon_links": [
{
"name": "PyPI",
"url": P["urls"]["PyPI"],
"icon": "fa-solid fa-box",
},
{"name": "PyPI", "url": P["urls"]["PyPI"], "icon": "fa-solid fa-box"}
],
"logo": {
"text": P["name"]
},
"navigation_with_keys": False,
"pygment_light_style": "github-light",
"pygment_dark_style": "github-dark",
"navigation_with_keys": False,
"use_edit_page_button": True,
}

github_user, github_repo = P["urls"]["Source"].split("/")[-2:]
Expand All @@ -57,16 +58,13 @@
}
# rely on the order of these to patch json, labextensions correctly
html_static_path = [
"./_static",
# as-built assets for testing "hot" downstreams against a PR without rebuilding
"../dist",
# as-built application, extensions, contents, and patched jupyter-lite.json
"../build/docs-app",
]

# TODO: add the pyodide logo
# html_theme_options = {
# "logo": {
# "image_light": "TODO",
# "image_dark": "TODO",
# }
# }
html_css_files = [
"variables.css",
]
3 changes: 3 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
```{include} ../CONTRIBUTING.md
```

```{include} ../RELEASE.md
```

0 comments on commit c24affc

Please sign in to comment.