Skip to content

Commit

Permalink
Merge pull request #120 from willingc/docs-update
Browse files Browse the repository at this point in the history
Fixing some minor docs things
  • Loading branch information
parente committed Mar 7, 2016
2 parents ff45e2b + df97a2e commit cf2cdd3
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 13 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Jupyter Kernel Gateway
[![Documentation Status](http://readthedocs.org/projects/jupyter-kernel-gateway/badge/?version=latest)](http://jupyter-kernel-gateway.readthedocs.org/en/latest/?badge=latest)

## Overview

Expand Down
26 changes: 16 additions & 10 deletions docs/source/getting-started.md
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.

2 changes: 1 addition & 1 deletion docs/source/http-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ See the [setting_response_metadata.ipynb](etc/api_examples/setting_response_meta

### Swagger Spec

The resource `/_api/spec/swagger.json` is automatically generated from the notebook used to define the HTTP API. The response is a simple Swagger spec which can be used with the [Swagger editor](http://editor.swagger.io/#/), a [Swagger ui](https://github.com/swagger-api/swagger-ui), or with any other Swagger-aware tool.
The resource `/_api/spec/swagger.json` is automatically generated from the notebook used to define the HTTP API. The response is a simple Swagger spec which can be used with the [Swagger editor](http://editor.swagger.io/#), a [Swagger ui](https://github.com/swagger-api/swagger-ui), or with any other Swagger-aware tool.

Currently, every response is listed as having a status of `200 OK`.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Contents:
:maxdepth: 2
:caption: About Jupyter Kernel Gateway

changelog
summary-changes

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/uses.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Jupyter Kernel Gateway:
kernels (e.g., dashboards using
[jupyter-js-services](https://github.com/jupyter/jupyter-js-services))
* Scale kernels independently from clients (e.g., via
[tmpnb](https://github.com/jupyter/tmpnb), [Binder](https://mybinder.org),
[tmpnb](https://github.com/jupyter/tmpnb), [Binder](http://mybinder.org/),
or your favorite cluster manager)
* Create microservices from notebooks via
[`notebook-http` mode](#notebook-http-mode)
Expand Down

0 comments on commit cf2cdd3

Please sign in to comment.