mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-02-17 12:39:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

Re-order installation instructions

Browse Source
This commit is contained in:
Matthias Geier 2016-03-15 15:28:08 +01:00
parent daedb4da79
commit 60f1aa14ea
1 changed files with 31 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
CONTRIBUTING.rst
View File

@ -15,18 +15,6 @@ __ http://jupyter.readthedocs.org/#contributor-documentation
Setting Up a Development Environment
------------------------------------
If you have already installed the dependencies mentioned below, the following
steps should get you going::
pip install setuptools pip --upgrade --user
git clone https://github.com/jupyter/notebook
cd notebook
pip install -e . --user
If you want the development environment to be available for all users of your
system (assuming you have the necessary rights), just drop the ``--user``
option.
Installing the Dependencies
^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -73,6 +61,22 @@ of the ``node`` package::
sudo apt-get install nodejs-legacy npm
Installing the Jupyter Notebook
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have installed the dependencies mentioned above, use the following
steps::
pip install setuptools pip --upgrade --user
git clone https://github.com/jupyter/notebook
cd notebook
pip install -e . --user
If you want the development environment to be available for all users of your
system (assuming you have the necessary rights), just drop the ``--user``
option.
Rebuilding JavaScript and CSS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -108,6 +112,21 @@ See ``git-hooks/README.md`` for more details.
Running Tests
-------------
Python Tests
^^^^^^^^^^^^
Install dependencies::
pip install -e .[test] --user
To run the Python tests, use::
nosetests
If you want coverage statistics as well, you can run::
nosetests --with-coverage --cover-package=notebook notebook
JavaScript Tests
^^^^^^^^^^^^^^^^
@ -130,21 +149,6 @@ or to run just ``notebook/tests/notebook/deletecell.js``::
python -m notebook.jstest notebook/deletecell.js
Python Tests
^^^^^^^^^^^^
Install dependencies::
pip install -e .[test] --user
To run the Python tests, use::
nosetests
If you want coverage statistics as well, you can run::
nosetests --with-coverage --cover-package=notebook notebook
Building the Documentation
--------------------------