Skip to content

Commit e7ec80e

Browse files
committed
editorial changes
1 parent 1246f1e commit e7ec80e

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

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

1515
# Development Setup
1616

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.
1919
The following steps assume that you have `git`, `python`, `pip`, and `make`
2020
already installed and on the system search path.
2121
You might want to set up the development project in a dedicated
@@ -25,9 +25,10 @@ depending on what Python distribution you are using.
2525

2626
## Clone the Repository
2727

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/`:
3132

3233
cd /my/projects/
3334
git clone https://github.com/jupyter/jupyter_client.git
@@ -49,8 +50,9 @@ include the dependencies for the test suite:
4950
pip install -e .[test]
5051

5152
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`.
5456

5557
# in a virtual environment...
5658
pip install sphinx sphinx_rtd_theme
@@ -82,5 +84,5 @@ Use `make` to build the documentation in HTML:
8284

8385
Point your browser to the following URL to access the generated documentation:
8486

85-
[file:///my/projects/jupyter_client/docs/_build/html/index.html]
87+
_file:///my/projects/jupyter_client/docs/_build/html/index.html_
8688

0 commit comments

Comments
 (0)