From 4d08d3c1882e4f367f1f1927e0c3d0272d3fbe2a Mon Sep 17 00:00:00 2001 From: Alexander Scammon Date: Thu, 17 Oct 2019 00:39:56 -0700 Subject: [PATCH] Add dependencies for dashboard to installation.rst (#5942) Updating the docs to include pip installing `aiohttp` and `psutil`, both of which the dashboard requires. Since the whole dashboard section is optional, I thought I'd just add it in the docs rather than make it an explicit requirement of the project. Tell me if you'd prefer them as requirements in the `setup.py`, though. --- doc/source/installation.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/doc/source/installation.rst b/doc/source/installation.rst index c56dad898..b540e358c 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -120,7 +120,19 @@ steps are included in the installation instructions above. .. _`Node.js`: https://nodejs.org/ -The dashboard requires Python 3, and can be enabled by setting +The dashboard also requires: + +- Python 3 +- aiohttp +- psutil + +The latter two can be installed via pip: + +.. code-block:: bash + + pip install aiohttp psutil + +The dashboard is enabled by setting ``include_webui=True`` during initialization, i.e. .. code-block:: python