Skip to content

Commit 94122d6

Browse files
authored
Merge pull request #2305 from minrk/contributing-tweak
minor updates to CONTRIBUTING installation instructions
2 parents 0087065 + 885ebc3 commit 94122d6

File tree

1 file changed

+13
-17
lines changed

1 file changed

+13
-17
lines changed

CONTRIBUTING.rst

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,20 @@ Installing Node.js and npm
2424
^^^^^^^^^^^^^^^^^^^^^^^^^^
2525

2626
Building the Notebook from its GitHub source code requires some tools to
27-
create and minify JavaScript components and the CSS.
28-
Namely, that's Node.js and Node's package manager, ``npm``.
27+
create and minify JavaScript components and the CSS,
28+
specifically Node.js and Node's package manager, ``npm``.
29+
It should be node version ≥ 6.0.
2930

3031
If you use ``conda``, you can get them with::
3132

32-
conda install -c javascript nodejs
33+
conda install -c conda-forge nodejs
3334

3435
If you use `Homebrew <http://brew.sh/>`_ on Mac OS X::
3536

3637
brew install node
3738

38-
For Debian/Ubuntu systems, you should use the ``nodejs-legacy`` package instead
39-
of the ``node`` package::
40-
41-
sudo apt-get update
42-
sudo apt-get install nodejs-legacy npm
39+
Installation on Linux may vary, but be aware that the `nodejs` or `npm` packages
40+
included in the system package repository may be too old to work properly.
4341

4442
You can also use the installer from the `Node.js website <https://nodejs.org>`_.
4543

@@ -50,14 +48,13 @@ Installing the Jupyter Notebook
5048
Once you have installed the dependencies mentioned above, use the following
5149
steps::
5250

53-
pip install setuptools pip --upgrade --user
51+
pip install --upgrade setuptools pip
5452
git clone https://github.com/jupyter/notebook
5553
cd notebook
56-
pip install -e . --user
54+
pip install -e .
5755

58-
If you want the development environment to be available for all users of your
59-
system (assuming you have the necessary rights) or if you are installing in a
60-
virtual environment, just drop the ``--user`` option.
56+
If you are using a system-wide Python installation and you only want to install the notebook for you,
57+
you can add ``--user`` to the install commands.
6158

6259
Once you have done this, you can launch the master branch of Jupyter notebook
6360
from any directory in your system with::
@@ -108,7 +105,7 @@ Python Tests
108105

109106
Install dependencies::
110107

111-
pip install -e .[test] --user
108+
pip install -e .[test]
112109

113110
To run the Python tests, use::
114111

@@ -157,10 +154,9 @@ containing all the necessary packages (except pandoc), use::
157154
.. _conda environment:
158155
http://conda.pydata.org/docs/using/envs.html#use-environment-from-file
159156

160-
If you want to install the necessary packages with ``pip`` instead, use
161-
(omitting --user if working in a virtual environment)::
157+
If you want to install the necessary packages with ``pip`` instead::
162158

163-
pip install -r docs/doc-requirements.txt --user
159+
pip install -r docs/doc-requirements.txt
164160

165161
Once you have installed the required packages, you can build the docs with::
166162

0 commit comments

Comments
 (0)