-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #120 from willingc/docs-update
Fixing some minor docs things
- Loading branch information
Showing
5 changed files
with
20 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,34 @@ | ||
## Getting started | ||
|
||
This document describes some of the basics of installing and configuring | ||
Jupyter Kernel. | ||
Jupyter Kernel Gateway. | ||
|
||
### Installation | ||
|
||
See [the readme](https://github.com/jupyter-incubator/kernel_gateway/blob/master/README.md) | ||
for help installing Jupyter Kernel Gateway. | ||
|
||
### Try It | ||
The Jupyter Kernel Gateway can be installed using `pip`. | ||
|
||
```bash | ||
# install from pypi | ||
pip install jupyter_kernel_gateway | ||
``` | ||
|
||
As an alternative to installing the kernel gateway from pypi, one can also | ||
use the [minimal-kernel](https://hub.docker.com/r/jupyter/minimal-kernel/) | ||
image from the [docker-stacks](https://github.com/jupyter/docker-stacks) | ||
project to try out its functionalities. | ||
|
||
Additional information about using Docker with Jupyter Kernel Gateway is | ||
found in the [Developer Installation](devinstall.md) section. | ||
|
||
### Try It | ||
|
||
These command allow you to quickly configure and run the kernel gateway: | ||
|
||
```bash | ||
# show all config options | ||
jupyter kernelgateway --help-all | ||
|
||
# run it with default options | ||
jupyter kernelgateway | ||
``` | ||
|
||
As an alternative to installing the kernel gateway from pypi, one can also | ||
use the [minimal-kernel](https://hub.docker.com/r/jupyter/minimal-kernel/) | ||
image from the [docker-stacks](https://github.com/jupyter/docker-stacks) | ||
project to try out its functionalities. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters