Skip to content

Commit a9f36dc

Browse files
Update development installation instructions in contributing.rst.
1 parent 7b46065 commit a9f36dc

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

docs/source/contributing.rst

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,39 @@ Contributing
77
Development install
88
-------------------
99

10-
**Note:** You will need :ref:`Node.js <https://nodejs.org/>` and :ref:`Docker <https://www.docker.com/>` to build the extension package.
10+
You need to create a development environment with `nodejs` and `jupyterlab` installed. We are here proposing to use `micromamba`.
1111

12-
The ``jlpm`` command is JupyterLab's pinned version of
13-
:ref:`yarn <https://yarnpkg.com/>` that is installed with JupyterLab. You may use
14-
:ref:`yarn <https://yarnpkg.com/>` or :ref:`npm <https://www.npmjs.com/>` in lieu of ``jlpm`` below.
12+
.. code-block:: bash
13+
14+
# Create an environment with micromamba and install nodejs and jupyterlab
15+
micromamba create -n jupytercad_dev -c conda-forge nodejs jupyterlab -y
16+
17+
You then need to clone the repository, proceed to installation and rebuild the extension.
1518

1619
.. code-block:: bash
1720
1821
# Clone the repo to your local environment
1922
git clone https://github.com/jupytercad/JupyterCAD.git
2023
# Change directory to the jupytercad directory
2124
cd JupyterCAD
22-
# Install JupyterLab for jlpm
23-
pip install jupyterlab
24-
# Install package in development mode
25-
python scripts/dev-install.py
25+
# Install dependencies and the package in development mode
26+
jlpm install
27+
jlpm dev ## if you haven't Docker installed replace this line by `jlpm dev --no-occ-build`
2628
# Rebuild extension Typescript source after making changes
2729
jlpm run build
2830
31+
**Note:** There are 2 possibilities for the installation.
32+
33+
1) either you are using [Docker](https://www.docker.com/) to build `@jupytercad/opencascade` package and you need to run `jlpm dev` in the commands above.
34+
35+
2) or you are using a prebuilt version by calling `jlpm dev --no-occ-build` to install the package.
36+
37+
38+
**Note:** The `jlpm` command is JupyterLab's pinned version of
39+
[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
40+
`yarn` or `npm` in lieu of `jlpm` above.
41+
42+
2943
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
3044

3145
.. code-block:: bash

0 commit comments

Comments
 (0)