@@ -14,8 +14,8 @@ for installing kernelspecs for use with Jupyter frontends.
14
14
15
15
# Development Setup
16
16
17
- To develop and contribute code for Jupyter Client, you should set up
18
- a local development environment where you can run the test suite.
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
19
The following steps assume that you have ` git ` , ` python ` , ` pip ` , and ` make `
20
20
already installed and on the system search path.
21
21
You might want to set up the development project in a dedicated
@@ -25,9 +25,10 @@ depending on what Python distribution you are using.
25
25
26
26
## Clone the Repository
27
27
28
- Fetch the Jupyter Client source code by cloning the GitHub repository,
29
- or [ your fork] ( https://help.github.com/articles/fork-a-repo/ ) of it.
30
- To clone the original repository into a subdirectory of ` /my/projects/ ` :
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/ ` :
31
32
32
33
cd /my/projects/
33
34
git clone https://github.com/jupyter/jupyter_client.git
@@ -49,8 +50,9 @@ include the dependencies for the test suite:
49
50
pip install -e .[test]
50
51
51
52
The Jupyter Client documentation is built with
52
- [ Sphinx] ( http://www.sphinx-doc.org/en/stable/ ) . You can install that with ` pip ` ,
53
- or with ` conda ` you are using an Anaconda distribution.
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 ` .
54
56
55
57
# in a virtual environment...
56
58
pip install sphinx sphinx_rtd_theme
@@ -82,5 +84,5 @@ Use `make` to build the documentation in HTML:
82
84
83
85
Point your browser to the following URL to access the generated documentation:
84
86
85
- [ file :///my/projects/jupyter_client/docs/_ build/html/index.html ]
87
+ _ file :///my/projects/jupyter_client/docs/_ build/html/index.html _
86
88
0 commit comments