Skip to content

Commit 2d6771f

Browse files
authored
Merge pull request #5274 from plotly/marthacryan-patch-1
Update CONTRIBUTING.md to include jupyter lab local development instr…
2 parents f27f38f + 65e3b39 commit 2d6771f

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,20 @@ you can install all packages with:
120120
pip install -e '.[dev]'
121121
```
122122

123+
If you're testing local changes in Jupyter Lab or Jupyter Notebook, you'll want to run these commands when you're setting up your development environment:
124+
```bash
125+
pip install jupyter
126+
jupyter labextension develop .
127+
```
128+
If you don't run that command, your figure will not render in the Jupyter Lab/ Jupyter Notebook editors.
129+
130+
If you're changing any of the code under the `js/` directory, you'll also want to run these commands:
131+
```
132+
cd js/
133+
npm ci
134+
npm run build
135+
```
136+
123137
These commands also create an *editable install* of plotly.py
124138
so that you can test your changes iteratively without having to rebuild the plotly.py package explicitly;
125139
for more information please see

0 commit comments

Comments
 (0)