File tree Expand file tree Collapse file tree 2 files changed +32
-0
lines changed Expand file tree Collapse file tree 2 files changed +32
-0
lines changed Original file line number Diff line number Diff line change 28
28
]
29
29
30
30
html_theme = 'alabaster'
31
+
32
+ jupyter_sphinx_thebelab_config = {
33
+ "requestKernel" : True ,
34
+ "binderOptions" : {
35
+ "repo" : "jupyter-widgets/jupyter-sphinx" ,
36
+ },
37
+ }
Original file line number Diff line number Diff line change @@ -83,6 +83,31 @@ to ``jupyter-execute``::
83
83
when they are included with Sphinx autodoc.
84
84
85
85
86
+ Thebelab support
87
+ ----------------
88
+
89
+ To turn on `thebelab <https://thebelab.readthedocs.io/ >`_, specify its configuration directly
90
+ in ``conf.py ``:
91
+
92
+ .. code-block :: python
93
+
94
+ jupyter_sphinx_thebelab_config = {
95
+ ' requestKernel' : True ,
96
+ ' binderOptions' : {
97
+ ' repo' : " binder-examples/requirements" ,
98
+ },
99
+ }
100
+
101
+ With this configuration, thebelab is activated with a button click:
102
+
103
+ .. thebe-button :: Activate Thebelab
104
+
105
+ By default the button is added at the end of the document, but it may also be inserted anywhere using
106
+
107
+ .. code-block :: ReST
108
+
109
+ .. thebe-button:: Optional title
110
+
86
111
Directive options
87
112
-----------------
88
113
You may choose to hide the code of a cell, but keep its output visible using ``:hide-code: ``::
You can’t perform that action at this time.
0 commit comments