Skip to content

Commit 51d79ae

Browse files
committed
Add contributing.md section on updating plotly.js version
1 parent 24f6f0d commit 51d79ae

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
@@ -117,6 +117,20 @@ pip install -r optional-requirements.txt
117117
$ jupyter nbextension install --py --symlink --sys-prefix plotlywidget
118118
$ jupyter nbextension enable --py --sys-prefix plotlywidget
119119

120+
## Update to a new version of Plotly.js
121+
First update the version of the `plotly.js` dependency in `js/package.json`.
122+
123+
Then run the `updateplotlyjs` command with:
124+
125+
```bash
126+
$ python setup.py updateplotlyjs
127+
```
128+
129+
This will download new versions of `plot-schema.json` and `plotly.min.js` from
130+
the `plotly/plotly.js` GitHub repository (and place them in
131+
`plotly/package_data`). It will then regenerate all of the `graph_objs`
132+
classes based on the new schema.
133+
120134
## Testing
121135

122136
We take advantage of two tools to run tests:

0 commit comments

Comments
 (0)