Skip to content

Commit f05e5a9

Browse files
authored
Convert docs to Markdown (#6770)
* Convert docs to Markdown * lint * update refs * more update
1 parent f44ac97 commit f05e5a9

20 files changed

+590
-615
lines changed

docs/source/config_overview.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
(configuration-overview)=
2+
3+
# Configuration Overview
4+
5+
Beyond the default configuration settings, you can configure a rich array of
6+
options to suit your workflow. Here are areas that are commonly configured
7+
when using Jupyter Notebook:
8+
9+
> - {ref}`Jupyter's common configuration system <configure-common>`
10+
> - {ref}`Jupyter Server <configure-jupyter-server>`
11+
> - {ref}`Notebook extensions <configure-nbextensions>`
12+
13+
Let's look at highlights of each area.
14+
15+
(configure-common)=
16+
17+
## Jupyter's Common Configuration system
18+
19+
Jupyter applications, from the Notebook to JupyterHub to nbgrader, share a
20+
common configuration system. The process for creating a configuration file
21+
and editing settings is similar for all the Jupyter applications.
22+
23+
> - [Jupyter’s Common Configuration Approach](https://jupyter.readthedocs.io/en/latest/use/config.html)
24+
> - [Common Directories and File Locations](https://jupyter.readthedocs.io/en/latest/use/jupyter-directories.html)
25+
> - [Language kernels](https://jupyter.readthedocs.io/en/latest/projects/kernels.html)
26+
> - [traitlets](https://traitlets.readthedocs.io/en/latest/config.html#module-traitlets.config)
27+
> provide a low-level architecture for configuration.
28+
29+
(configure-jupyter-server)=
30+
31+
## Jupyter server
32+
33+
The Jupyter Server runs the language kernel and communicates with the
34+
front-end Notebook client (i.e. the familiar notebook interface).
35+
36+
> - Configuring the Jupyter Server
37+
>
38+
> > To create a `jupyter_server_config.py` file in the `.jupyter`
39+
> > directory, with all the defaults commented out, use the following
40+
> > command:
41+
> >
42+
> > ```
43+
> > $ jupyter server --generate-config
44+
> > ```
45+
>
46+
> - [Running a Jupyter Server](https://jupyter-server.readthedocs.io/en/stable/operators/public-server.html)
47+
>
48+
> - Related: [Configuring a language kernel](https://ipython.readthedocs.io/en/latest/install/kernel_install.html)
49+
> to run in the Jupyter Server enables your server to run other languages, like R or Julia.
50+
51+
(configure-nbextensions)=
52+
53+
## Notebook extensions
54+
55+
The Notebook frontend can be extending with JupyterLab extensions.
56+
57+
See the {ref}`Frontend Extension Guide <frontend-extensions>` for more information.
58+
59+
[Security in Jupyter notebooks:](https://jupyter-server.readthedocs.io/en/stable/operators/security.html)
60+
Since security policies vary from organization to organization, we encourage you to
61+
consult with your security team on settings that would be best for your use
62+
cases. Our documentation offers some responsible security practices, and we
63+
recommend becoming familiar with the practices.

docs/source/config_overview.rst

Lines changed: 0 additions & 63 deletions
This file was deleted.

docs/source/configuration.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Configuration
2+
3+
```{toctree}
4+
:caption: Configuration
5+
:maxdepth: 1
6+
7+
config_overview
8+
Security <https://jupyter-server.readthedocs.io/en/stable/operators/security.html>
9+
extending/index.rst
10+
```

docs/source/configuration.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/source/contributor.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributor
2+
3+
```{toctree}
4+
:caption: Contributor Documentation
5+
:maxdepth: 1
6+
7+
contributing
8+
development_faq
9+
```

docs/source/contributor.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/source/development_faq.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
(development-faq)=
2+
3+
# Developer FAQ
4+
5+
1. How do I install a prerelease version such as a beta or release candidate?
6+
7+
```bash
8+
python -m pip install notebook --pre --upgrade
9+
```

docs/source/development_faq.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
.. _frontend_extensions:
1+
(frontend-extensions)=
22

3-
===========================
4-
Custom front-end extensions
5-
===========================
3+
# Custom front-end extensions
64

75
This describes the basic steps to write a TypeScript extension for the Jupyter
86
notebook front-end. This allows you to customize the behaviour of the various
@@ -15,5 +13,5 @@ This means Notebook v7 is able to reuse many of the existing extensions from the
1513

1614
If you would like to develop a prebuilt extension for Notebook v7, check out:
1715

18-
- `JupyterLab Extension Tutorial <https://jupyterlab.readthedocs.io/en/latest/extension/extension_tutorial.html>`_: A tutorial to learn how to make a simple JupyterLab extension.
19-
- The `JupyterLab Extension Examples Repository <https://github.com/jupyterlab/extension-examples>`_: A short tutorial series to learn how to develop extensions for JupyterLab by example.
16+
- [JupyterLab Extension Tutorial](https://jupyterlab.readthedocs.io/en/latest/extension/extension_tutorial.html): A tutorial to learn how to make a simple JupyterLab extension.
17+
- The [JupyterLab Extension Examples Repository](https://github.com/jupyterlab/extension-examples): A short tutorial series to learn how to develop extensions for JupyterLab by example.

docs/source/extending/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Extending the Notebook
2+
3+
Certain subsystems of the notebook server are designed to be extended or
4+
overridden by users. These documents explain these systems, and show how to
5+
override the notebook's defaults with your own custom behavior.
6+
7+
```{toctree}
8+
:maxdepth: 2
9+
10+
Extending the Jupyter Server <https://jupyter-server.readthedocs.io/en/stable/developers/index.html>
11+
frontend_extensions
12+
```

0 commit comments

Comments
 (0)