Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update pyproject.toml and readme #67

Merged
merged 3 commits into from
Jul 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,20 +142,26 @@ conda uninstall jupyterlab_accessible_themes
```

7. Now you'll need to link the development version of the extension to JupyterLab and rebuild the Typescript source:
On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:

```bash
# Rebuild extension Typescript source after making changes
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
```

8. Run JupyterLab and check that the installation worked:
8. On the first installation, or after making some changes, to visualize them in your local JupyterLab re-run the following command:

```bash
# Run JupyterLab
jupyter lab
# Rebuild extension Typescript source after making changes
jlpm build
```

9. Run JupyterLab and check that the installation worked:

```bash
# Run JupyterLab
jupyter lab
```

> **Important**
> Once everything is installed, you will need to select the theme inside JupyterLab via the main menu `Settings > Theme`.

Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ build-backend = "jupyter_packaging.build_api"
[project]
name = "jupyterlab_accessible_themes"
requires-python = ">=3.8"
dynamic = ["version", "description", "readme", "license", "authors", "urls"]

[tool.jupyter-packaging.options]
skip-if-exists = ["jupyterlab_accessible_themes/labextension/static/style.js"]
Expand Down