Skip to content

Commit

Permalink
MAINT - Update pyproject.toml and readme (#67)
Browse files Browse the repository at this point in the history
* Update pyproject.toml

* Update README.md

* [pre-commit.ci] Apply automatic pre-commit fixes

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
steff456 and pre-commit-ci[bot] committed Jul 19, 2023
1 parent dc7c964 commit ff63d3f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
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

0 comments on commit ff63d3f

Please sign in to comment.