Remove notebook from docs, redirect to data portal (#12146)

This commit is contained in:
Franck Nijhof 2020-02-20 22:53:43 +01:00 committed by GitHub
parent e77bfc4293
commit 8b5d31a312
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 14 additions and 96 deletions

View File

@ -1,7 +0,0 @@
---
title: "Home Assistant Python API"
description: "Basic example of interacting with Home Assistant live from a Jupyter notebook using the Python API."
redirect_from: /ecosystem/notebooks/api/
---
Python API is deprecated.

View File

@ -1,7 +0,0 @@
---
title: "Database"
description: "Accessing the Home Assistant database from a Jupyter notebook."
redirect_from: /ecosystem/notebooks/database/
---
You can directly access the Home Assistant database from Jupyter notebooks. The [Database example](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/database-examples.ipynb) shows you how you can work with stored database values.

View File

@ -1,7 +0,0 @@
---
title: "Graph"
description: "Basic example how to create a graph with a Jupyter notebook."
redirect_from: /ecosystem/notebooks/graph/
---
For graphing this [Jupyter notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/graph-single-sensor.ipynb) should get you started.

View File

@ -1,45 +0,0 @@
---
title: "Installation"
description: "Setup and first steps for Jupyter Notebooks and Home Assistant."
redirect_from: /ecosystem/notebooks/installation/
---
To run Jupyter Notebooks locally, an installation of [Jupyter](http://jupyter.org/) is needed. Consider running Jupyter in a [virtualenv](/docs/installation/virtualenv/) in order to properly manage dependencies.
```bash
$ pip3 install jupyter matplotlib
```
<div class='note warning'>
Certain notebooks hosted in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks) require access to a running Home Assistant instance or parts of a Home Assistant installation. If you want to run those notebooks, install Home Assistant with `$ pip3 install homeassistant` as well.
</div>
Run Jupyter from the command line.
```bash
$ jupyter notebook
[I 17:22:18.081 NotebookApp] Writing notebook server cookie secret to /run/user/1000/jupyter/notebook_cookie_secret
[I 17:22:18.921 NotebookApp] Serving notebooks from local directory: /home/fabaff/home-assistant
[I 17:22:18.921 NotebookApp] 0 active kernels
[I 17:22:18.921 NotebookApp] The Jupyter Notebook is running at: http://localhost:8888/
[I 17:22:18.922 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
```
Open `http://localhost:8888/` in your browser. Press "New" -> "Python3" to open a new notebook.
<p class='img'>
<img src='{{site_root}}/images/screenshots/jupyter-new.png' />
</p>
You will get an empty notebook with one cell. Cells can contain code or text. To get the output of a cell you need to execute them with "Cell" -> "Run Cells" from the menu or by pressing the Play icon.
<p class='img'>
<img src='{{site_root}}/images/screenshots/jupyter-notebook.png' />
</p>
The downloadable version of this notebook is available in the [Home Assistant notebooks repository](https://github.com/home-assistant/home-assistant-notebooks/blob/master/other/first-notebook.ipynb).
As you can see is the Jupyter notebook workflow is very similar to working directly with a Python shell. One advantage of notebooks is that you can go back and forth between cells as you please and save your work.

View File

@ -1,7 +0,0 @@
---
title: "Statistics"
description: "Basic example how to create basic statistics with a Jupyter notebook."
redirect_from: /ecosystem/notebooks/stats/
---
The [Statistics notebook](https://nbviewer.jupyter.org/github/home-assistant/home-assistant-notebooks/blob/master/other/database-statistics.ipynb) shows some basic statistical analysis on data in the Home Assistant database.

View File

@ -270,27 +270,6 @@
<li>
{% active_link /docs/ecosystem/hadashboard/ HADashboard %}
</li>
<li>
{% active_link /docs/ecosystem/notebooks/ Notebooks %}
<ul>
<li>{% active_link /docs/ecosystem/notebooks/ Introduction %}</li>
<li>
{% active_link /docs/ecosystem/notebooks/installation/
Installation %}
</li>
<li>{% active_link /docs/ecosystem/notebooks/graph/ Graph %}</li>
<li>
{% active_link /docs/ecosystem/notebooks/api/ Home Assistant API
%}
</li>
<li>
{% active_link /docs/ecosystem/notebooks/database/ Database %}
</li>
<li>
{% active_link /docs/ecosystem/notebooks/stats/ Statistics %}
</li>
</ul>
</li>
<li>
Remote access
<ul>

View File

@ -2047,8 +2047,7 @@
# Breaking changes
/integrations/switch.pca /integrations/elv
# App documentation
/ios/whats-new https://companion.home-assistant.io/docs/getting_started/getting-started
# Moved documentation
/docs/ecosystem/ios/ https://companion.home-assistant.io/
/docs/ecosystem/ios/devices_file https://companion.home-assistant.io/
/docs/ecosystem/ios/integration https://companion.home-assistant.io/docs/integrations/integrations
@ -2062,7 +2061,20 @@
/docs/ecosystem/ios/notifications/privacy_security_rate_limits https://companion.home-assistant.io/docs/notifications/notifications-basic
/docs/ecosystem/ios/notifications/requesting_location_updates https://companion.home-assistant.io/docs/notifications/notifications-basic
/docs/ecosystem/ios/notifications/sounds https://companion.home-assistant.io/docs/notifications/notification-sounds
/docs/ecosystem/notebooks https://data.home-assistant.io
/docs/ecosystem/notebooks/api https://data.home-assistant.io
/docs/ecosystem/notebooks/database https://data.home-assistant.io
/docs/ecosystem/notebooks/graph https://data.home-assistant.io
/docs/ecosystem/notebooks/installation https://data.home-assistant.io
/docs/ecosystem/notebooks/stats https://data.home-assistant.io
/ecosystem/ios/notifications https://companion.home-assistant.io/docs/notifications/notifications-basic
/ecosystem/notebooks https://data.home-assistant.io
/ecosystem/notebooks/api https://data.home-assistant.io
/ecosystem/notebooks/database https://data.home-assistant.io
/ecosystem/notebooks/graph https://data.home-assistant.io
/ecosystem/notebooks/installation https://data.home-assistant.io
/ecosystem/notebooks/stats https://data.home-assistant.io
/ios/whats-new https://companion.home-assistant.io/docs/getting_started/getting-started
# Add-ons
/addons/cec_scan https://github.com/home-assistant/hassio-addons/blob/master/cec_scan/README.md