Skip to content

Clarified installation process for development #2551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 10, 2020
Merged

Clarified installation process for development #2551

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5df126f
Clarified installation process for development
nicholas-esterer Jun 8, 2020
7d76853
Merge branch 'master' into issue-2550
nicholas-esterer Jun 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ the structure of the code and of the repository.
https://github.com/plotly/plotly.py/issues/1965. If you have writing skills,
the wording of existing examples can also be improved in places.

Contributing code or documentation are not the only way to contribute! You can
Contributing code or documentation is not the only way to contribute! You can
also contribute to the project by

- reporting bugs (see below).
Expand Down Expand Up @@ -151,7 +151,12 @@ complete installation and avoid gdal-config errors.
```
This will ensure that the installed packages links to your local development
directory, meaning that all changes you make reflect directly in your
environment (don't forget to restart the Jupyter kernel though!).
environment (don't forget to restart the Jupyter kernel though!). For more
information see the
[`setuptools`](https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode)
and
[`pip`](https://pip.pypa.io/en/stable/reference/pip_install/#install-editable)
documentation on _development mode_.

### ipywidgets development install

Expand Down