Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release prep #711

Merged
merged 2 commits into from
Jun 11, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/content/execute.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
51 changes: 45 additions & 6 deletions docs/interactive/interactive.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"pyyaml",
"docutils>=0.15",
"sphinx<3",
"myst-nb>=0.8.1",
"myst-nb~=0.8",
"click",
"setuptools",
"nbformat",
Expand All @@ -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"],
Expand Down