Skip to content

Commit f05f948

Browse files
authored
Merge pull request #347 from mwouts/less_warnings_in_docs_make_html
Fix all warnings (but 2) when doing make html
2 parents d63af55 + 7ef35b9 commit f05f948

File tree

5 files changed

+18
-12
lines changed

5 files changed

+18
-12
lines changed

docs/environment.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
name: kernel_gateway_docs
2+
channels:
3+
- defaults
4+
- conda-forge
25
dependencies:
3-
- python=3.5
4-
- sphinx_rtd_theme
5-
- sphinx
6-
- pip:
7-
- recommonmark
6+
- python=3.7
7+
- sphinx
8+
- sphinx_rtd_theme
9+
- recommonmark
10+
- pillow
11+
- pip
12+
- pip:
13+
- readthedocs-sphinx-ext

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@
152152
# Add any paths that contain custom static files (such as style sheets) here,
153153
# relative to this directory. They are copied after the builtin static files,
154154
# so a file named "default.css" will overwrite the builtin "default.css".
155-
html_static_path = ['_static']
155+
# html_static_path = ['_static']
156156

157157
# Add any extra paths that contain custom files (such as robots.txt or
158158
# .htaccess) here, relative to this directory. These files are copied

docs/source/devinstall.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@ make test
4040

4141
### Run the gateway server
4242

43-
Run an instance of the kernel gateway server in [`jupyter-websocket` mode](websocket-mode).
43+
Run an instance of the kernel gateway server in [`jupyter-websocket` mode](websocket-mode.md).
4444

4545
```bash
4646
make dev
4747
```
4848

4949
Then access the running server at the URL printed in the console.
5050

51-
Run an instance of the kernel gateway server in [`notebook-http` mode](http-mode.html) using the `api_intro.ipynb` notebook in the repository.
51+
Run an instance of the kernel gateway server in [`notebook-http` mode](http-mode.md) using the `api_intro.ipynb` notebook in the repository.
5252

5353
```bash
5454
make dev-http

docs/source/features.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
The Jupyter Kernel Gateway has the following features:
44

5-
* [`jupyter-websocket` mode](websocket-mode.html) which provides a
5+
* [`jupyter-websocket` mode](websocket-mode.md) which provides a
66
Jupyter Notebook server-compatible API for requesting kernels and
77
communicating with them using Websockets
8-
* [`notebook-http` mode](http-mode.html) which maps HTTP requests to
8+
* [`notebook-http` mode](http-mode.md) which maps HTTP requests to
99
cells in annotated notebooks
1010
* Option to enable other kernel communication mechanisms by plugging in third party personalities
1111
* Option to set a shared authentication token and require it from clients
@@ -18,7 +18,7 @@ The Jupyter Kernel Gateway has the following features:
1818
in the request
1919
* Option to pre-populate kernel memory from a notebook
2020
* Option to serve annotated notebooks as HTTP endpoints, see
21-
[notebook-http](http-mode.html)
21+
[notebook-http](http-mode.md)
2222
* Option to allow downloading of the notebook source when running
2323
in `notebook-http` mode
2424
* Generation of [Swagger specs](http://swagger.io/introducing-the-open-api-initiative/)

docs/source/uses.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Jupyter Kernel Gateway makes possible the following novel uses of kernels:
1111
[tmpnb](https://github.com/jupyter/tmpnb), [Binder](http://mybinder.org/),
1212
or your favorite cluster manager)
1313
* Create microservices from notebooks via
14-
[`notebook-http` mode](http-mode.html)
14+
[`notebook-http` mode](http-mode.md)
1515

1616
The following diagram shows how you might use `tmpnb` to deploy a pool of kernel gateway instances in Docker containers to support on-demand interactive compute:
1717

0 commit comments

Comments
 (0)