Release prep (#711)

jupyter-book · Jun 11, 2020 · bf4d660 · bf4d660
1 parent eca0b69
commit bf4d660
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 8 deletions.
diff --git a/docs/content/execute.md b/docs/content/execute.md
@@ -125,6 +125,17 @@ The path should point to an **empty folder**, or a folder where a
 
 ## Execution FAQs
 
+### How does execution deal with relative paths in my code?
+
+The behavior of relative paths in your code is slightly different depending on
+whether you're executing with `auto` or with `cache`.
+
+* **If executing with `auto`** notebooks will execute in the folder where they
+  exist and relative paths will work.
+* **If executing with `cache`** then the notebook will execute in a temporary
+  folder, and relative paths will not work. Support for relative paths is planned
+  for the future.
+
 ### How can I include code that raises errors?
 
 In some cases, you may want to intentionally show code that doesn't work (e.g., to show

diff --git a/docs/interactive/interactive.md b/docs/interactive/interactive.md
@@ -27,10 +27,6 @@ data = px.data.iris()
 data.head()
 ```
 
-```{warning}
-Jupyter Book does not yet support ipywidgets, but it wants to do so!
-```
-
 ## Altair
 
 Interactive outputs will work under the assumption that the outputs they produce have
@@ -67,8 +63,6 @@ import plotly.io as pio
 import plotly.express as px
 import plotly.offline as py
 
-pio.renderers.default = "notebook"
-
 df = px.data.iris()
 fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species", size="sepal_length")
 fig
@@ -96,3 +90,48 @@ p = figure()
 p.circle(data["sepal_width"], data["sepal_length"], fill_color=data["species"], size=data["sepal_length"])
 show(p)
 ```
+
+
+## ipywidgets
+
+You may also run code for Jupyter Widgets in your document, and the interactive HTML
+outputs will embed themselves in your side. See [the ipywidgets documentation](https://ipywidgets.readthedocs.io/en/latest/user_install.html)
+for how to get set up in your own environment.
+
+```{admonition} Widgets often need a kernel
+Note that `ipywidgets` tend to behave differently from other interactive viz libraries. They
+interact both with Javascript, and with Python. Some functionality in `ipywidgets` may not
+work in default Jupyter Book pages (because no Python kernel is running). You may be able to
+get around this with [tools for remote kernels, like thebelab](https://thebelab.readthedocs.org).
+```
+
+Here are some simple widget elements rendered below.
+
+```{code-cell} ipython3
+import ipywidgets as widgets
+widgets.IntSlider(
+    value=7,
+    min=0,
+    max=10,
+    step=1,
+    description='Test:',
+    disabled=False,
+    continuous_update=False,
+    orientation='horizontal',
+    readout=True,
+    readout_format='d'
+)
+```
+
+```{code-cell} ipython3
+tab_contents = ['P0', 'P1', 'P2', 'P3', 'P4']
+children = [widgets.Text(description=name) for name in tab_contents]
+tab = widgets.Tab()
+tab.children = children
+for ii in range(len(children)):
+    tab.set_title(ii, f"tab_{ii}")
+tab
+```
+
+You can find [a list of possible Jupyter Widgets](https://ipywidgets.readthedocs.io/en/latest/examples/Widget%20List.html)
+in the jupyter-widgets documentation.
diff --git a/setup.py b/setup.py
@@ -49,7 +49,7 @@
         "pyyaml",
         "docutils>=0.15",
         "sphinx<3",
-        "myst-nb>=0.8.1",
+        "myst-nb~=0.8",
         "click",
         "setuptools",
         "nbformat",
@@ -58,7 +58,7 @@
         "sphinx_togglebutton",
         "sphinx-copybutton",
         "sphinxcontrib-bibtex",
-        "sphinx_book_theme>=0.0.23",
+        "sphinx_book_theme~=0.0",
     ],
     extras_require={
         "code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],