Skip to content

Commit 8ede2a1

Browse files
committed
cut down the dev description, link to the Jupyter Guides
1 parent f5d2160 commit 8ede2a1

File tree

1 file changed

+14
-56
lines changed

1 file changed

+14
-56
lines changed

README.md

Lines changed: 14 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -14,73 +14,31 @@ for installing kernelspecs for use with Jupyter frontends.
1414

1515
# Development Setup
1616

17-
To develop and contribute code for the Jupyter Client, you should set up
18-
a development environment to run the test suite and build the documentation.
19-
The following steps assume that you have `git`, `python`, `pip`, and `make`
20-
already installed and on the system search path.
21-
You might want to set up the development project in a dedicated
22-
[virtual environment](https://virtualenv.pypa.io/en/stable/) or
23-
[conda environment](https://conda.io/docs/using/envs.html),
24-
depending on what Python distribution you are using.
25-
26-
## Clone the Repository
27-
28-
Fetch the Jupyter Client source code by cloning the GitHub repository itself,
29-
or your [fork](https://help.github.com/articles/fork-a-repo/) of it.
30-
To clone the original repository into a subdirectory `jupyter_client` of
31-
`/my/projects/`:
32-
33-
cd /my/projects/
34-
git clone https://github.com/jupyter/jupyter_client.git
35-
36-
If you have configured an SSH key pair for GitHub authentication, use the
37-
[SSH URL](https://help.github.com/articles/which-remote-url-should-i-use/)
38-
for cloning instead. But then you already know how to do that anyway.
39-
40-
## Install the Dependencies
41-
42-
The Jupyter Client code depends on several other Python packages at runtime.
43-
The test suite requires a few more packages on top of that.
44-
An [editable install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
45-
with `pip` will download the dependencies, and add your local clone of the
46-
Jupyter Client to the Python environment. To create the editable install and
47-
include the dependencies for the test suite:
17+
The [Jupyter Contributor Guides](http://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html) provide extensive information on contributing code or documentation to Jupyter projects. The limited instructions below for setting up a development environment are for your convenience.
4818

49-
cd /my/projects/jupyter_client/
50-
pip install -e .[test]
51-
52-
The Jupyter Client documentation is built with
53-
[Sphinx](http://www.sphinx-doc.org/en/stable/).
54-
You can install that with `pip` or,
55-
if you are using an Anaconda distribution, with `conda`.
56-
57-
# in a virtual environment...
58-
pip install sphinx sphinx_rtd_theme
19+
## Coding
5920

60-
# in a conda environment...
61-
conda install sphinx sphinx_rtd_theme
62-
63-
## Run the Test Suite
64-
65-
Use `py.test` to run the test suite:
21+
You'll need Python and `pip` on the search path. Clone the Jupyter Client git repository to your computer, for example in `/my/project/jupyter_client`.
22+
Now create an [editable install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
23+
and download the dependencies of code and test suite by executing:
6624

6725
cd /my/projects/jupyter_client/
26+
pip install -e .[test]
6827
py.test
6928

70-
The full test suite takes a while. During development, you'll probably prefer
71-
to run only the tests relevant to your changes. You can tell `py.test` to
72-
run just the tests from a single file by providing the path to the file.
73-
For example:
29+
The last command runs the test suite to verify the setup. During development, you can pass filenames to `py.test`, and it will execute only those tests.
7430

75-
cd /my/projects/jupyter_client
76-
py.test jupyter_client/tests/test_session.py
31+
## Documentation
7732

78-
## Build the Documentation
33+
The documentation of Jupyter Client is generated from the files in `docs/` using Sphinx. Instructions for setting up Sphinx with a selection of optional modules are in the [Documentation Guide](http://jupyter.readthedocs.io/en/latest/contrib_docs/index.html). You'll also need the `make` command.
34+
For a minimal Sphinx installation to process the Jupyter Client docs, execute:
35+
36+
pip install sphinx sphinx_rtd_theme
7937

80-
Use `make` to build the documentation in HTML:
38+
The following commands build the documentation in HTML format and check for broken links:
8139

8240
cd /my/projects/jupyter_client/docs/
83-
make html
41+
make html linkcheck
8442

8543
Point your browser to the following URL to access the generated documentation:
8644

0 commit comments

Comments
 (0)