Skip to content

Commit 710f0b3

Browse files
authored
Merge pull request jupyterhub#236 from manics/linkable-argument-docs
Replace server-process list with linkable headings
2 parents 81a8e75 + e69340d commit 710f0b3

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

docs/server-process.rst

+16-8
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Server Process options
1818
Server Processes are configured with a dictionary of key value
1919
pairs.
2020

21-
#. **command**
21+
``command``
22+
^^^^^^^^^^^
2223

2324
One of:
2425

@@ -37,14 +38,16 @@ pairs.
3738

3839
This key is required.
3940

40-
#. **timeout**
41+
``timeout``
42+
^^^^^^^^^^^
4143

4244
Timeout in seconds for the process to become ready, default ``5``.
4345

4446
A process is considered 'ready' when it can return a valid HTTP response on the
4547
port it is supposed to start at.
4648

47-
#. **environment**
49+
``environment``
50+
^^^^^^^^^^^^^^^
4851

4952
One of:
5053

@@ -56,7 +59,8 @@ pairs.
5659
* A callable that takes any :ref:`callable arguments <server-process/callable-argument>`,
5760
and returns a dictionary of strings that are used & treated same as above.
5861

59-
#. **absolute_url**
62+
``absolute_url``
63+
^^^^^^^^^^^^^^^^
6064

6165
*True* if the URL as seen by the proxied application should be the full URL
6266
sent by the user. *False* if the URL as seen by the proxied application should
@@ -84,20 +88,23 @@ pairs.
8488
Defaults to *False*.
8589

8690

87-
#. **port**
91+
``port``
92+
^^^^^^^^
8893

8994
Set the port that the service will listen on. The default is to
9095
automatically select an unused port.
9196

9297

93-
#. **mappath**
98+
``mappath``
99+
^^^^^^^^^^^
94100

95101
Map request paths to proxied paths.
96102
Either a dictionary of request paths to proxied paths,
97103
or a callable that takes parameter ``path`` and returns the proxied path.
98104

99105

100-
#. **launcher_entry**
106+
``launcher_entry``
107+
^^^^^^^^^^^^^^^^^^
101108

102109
A dictionary with options on if / how an entry in the classic Jupyter Notebook
103110
'New' dropdown or the JupyterLab launcher should be added. It can contain
@@ -115,7 +122,8 @@ pairs.
115122
Title to be used for the launcher entry. Defaults to the name of the server if missing.
116123

117124

118-
#. **new_browser_tab**
125+
``new_browser_tab``
126+
^^^^^^^^^^^^^^^^^^^
119127

120128
*JupyterLab only* - *True* if the proxied server URL should be opened in a new browser tab.
121129
*False* (default) if the proxied server URL should be opened in a new JupyterLab tab.

0 commit comments

Comments
 (0)