Skip to content
This repository has been archived by the owner on Feb 14, 2024. It is now read-only.

Development build instructions are broken #70

Open
omert opened this issue Aug 17, 2022 · 1 comment
Open

Development build instructions are broken #70

omert opened this issue Aug 17, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@omert
Copy link

omert commented Aug 17, 2022

There are some issues with the development build instructions. Some are mistakes, and others are places where the instructions might be more helpful.

Here are the current development build instructions, with issues interspersed.

# Clone the repo to your local environment
# Change directory to the jupyterlite_xeus_python directory

Changing into this directory makes the next command not work.

# Install package in development mode
python -m pip install -e .

# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite

This requires jupyter to be installed. What is the best way to do that? Should conda be used, and if so how?

# Rebuild extension Typescript source after making changes
jlpm run build

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

What if we we want to run jupyterlite rather than Jupyter?

@omert omert added the documentation Improvements or additions to documentation label Aug 17, 2022
@martinRenou
Copy link
Member

Thanks for opening an issue.

Indeed, the README is really not up-to-date. It might have been a copy-paste from another Jupyter project but it does not apply here.

I will push a PR soonish to update it.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants