Skip to content

Fixed setup commands in contributing doc #543

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 4 commits into from
Jul 9, 2024
Merged

Fixed setup commands in contributing doc #543

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b522a70
fixed description in contributing doc and made it more future-proof
mwlon Jul 6, 2024
a639b73
rst, not md
mwlon Jul 6, 2024
e6d44ac
Merge branch 'main' into python-version-fix
normanrz Jul 8, 2024
c2ed4bd
Merge branch 'main' into python-version-fix
normanrz Jul 9, 2024
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
10 changes: 5 additions & 5 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,12 @@ Creating a development environment
To work with the NumCodecs source code, it is recommended to set up a Python virtual
environment and install all NumCodecs dependencies using the same versions as are used by
the core developers and continuous integration services. Assuming you have a Python
3 interpreter already installed, and have also installed the virtualenv package, and
you have cloned the NumCodecs source code and your current working directory is the root of
the repository, you can do something like the following::
3 interpreter already installed matching the ``requires-python`` constraint from
``pyproject.toml``, and you have cloned the NumCodecs source code and your
current working directory is the root of the repository, you can do something
like the following::

$ mkdir -p ~/pyenv/numcodecs-dev
$ virtualenv --no-site-packages --python=/usr/bin/python3.9 ~/pyenv/numcodecs-dev
$ python3 -m venv ~/pyenv/numcodecs-dev
$ source ~/pyenv/numcodecs-dev/bin/activate
$ pip install -e .[docs,test,msgpack,zfpy]

Expand Down