From 8b5d31a3125396c5ec325570be6365d2f8107813 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 20 Feb 2020 22:53:43 +0100 Subject: [PATCH] Remove notebook from docs, redirect to data portal (#12146) --- source/_docs/ecosystem/notebooks/api.markdown | 7 --- .../ecosystem/notebooks/database.markdown | 7 --- .../_docs/ecosystem/notebooks/graph.markdown | 7 --- .../ecosystem/notebooks/installation.markdown | 45 ------------------- .../_docs/ecosystem/notebooks/stats.markdown | 7 --- source/_includes/asides/docs_navigation.html | 21 --------- source/_redirects | 16 ++++++- 7 files changed, 14 insertions(+), 96 deletions(-) delete mode 100644 source/_docs/ecosystem/notebooks/api.markdown delete mode 100644 source/_docs/ecosystem/notebooks/database.markdown delete mode 100644 source/_docs/ecosystem/notebooks/graph.markdown delete mode 100644 source/_docs/ecosystem/notebooks/installation.markdown delete mode 100644 source/_docs/ecosystem/notebooks/stats.markdown diff --git a/source/_docs/ecosystem/notebooks/api.markdown b/source/_docs/ecosystem/notebooks/api.markdown deleted file mode 100644 index 063510542e23..000000000000 --- a/source/_docs/ecosystem/notebooks/api.markdown +++ /dev/null @@ -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. diff --git a/source/_docs/ecosystem/notebooks/database.markdown b/source/_docs/ecosystem/notebooks/database.markdown deleted file mode 100644 index 11ad7cce37b2..000000000000 --- a/source/_docs/ecosystem/notebooks/database.markdown +++ /dev/null @@ -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. diff --git a/source/_docs/ecosystem/notebooks/graph.markdown b/source/_docs/ecosystem/notebooks/graph.markdown deleted file mode 100644 index c48a18a3849f..000000000000 --- a/source/_docs/ecosystem/notebooks/graph.markdown +++ /dev/null @@ -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. diff --git a/source/_docs/ecosystem/notebooks/installation.markdown b/source/_docs/ecosystem/notebooks/installation.markdown deleted file mode 100644 index 0afed74486d0..000000000000 --- a/source/_docs/ecosystem/notebooks/installation.markdown +++ /dev/null @@ -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 -``` - -
- -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. - -
- -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. - -

- -

- -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. - -

- -

- -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. diff --git a/source/_docs/ecosystem/notebooks/stats.markdown b/source/_docs/ecosystem/notebooks/stats.markdown deleted file mode 100644 index c1232bcb0392..000000000000 --- a/source/_docs/ecosystem/notebooks/stats.markdown +++ /dev/null @@ -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. diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index 62864cb173fe..9edc7e8b6da7 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -270,27 +270,6 @@

Topics

  • {% active_link /docs/ecosystem/hadashboard/ HADashboard %}
    • -
  • - {% active_link /docs/ecosystem/notebooks/ Notebooks %} - -
  • Remote access