From 0ea8b995e91999f33ff2f8f815abd6dba98e66f0 Mon Sep 17 00:00:00 2001 From: Andrew Head Date: Mon, 4 Feb 2019 14:48:11 -0800 Subject: [PATCH] Docs: Added troubleshooting notes --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 037db42..97b101d 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ npm run install_nb_extension ### Troubleshooting -##### The extension UI doesn't get loaded +#### The extension UI doesn't get loaded Sometimes you might reload the page and see that the buttons on the page are missing. I haven't been able to track the cause of the issue. [This Stack Overflow post](https://stackoverflow.com/questions/11991218/undefined-object-being-passed-via-requirejs) suggests the issue might be with circular `require` dependencies. The problem has disappeared when I have: @@ -45,7 +45,7 @@ But I don't know if either of these *really* fixed the issue. They're worth tryi Then run `jupyter notebook` and the extension will be running. -### `500` message when launching Jupyter notebook +#### `500` message when launching Jupyter notebook Install these versions of Jupyter notebook and dependencies to see something working, before trying out other versions: @@ -56,6 +56,13 @@ nbformat==4.4.0 notebook==5.6.0 ``` +#### Build errors + +* **Errors about missing semicolons in React types files**: upgrade the `typescript` and `ts-node` packages +* **Conflicting dependencies**: upgrade either the Python Jupyter Lab (may require Python upgrade) or the Jupyter Lab npm pacakges +* **Issues with duplicated React types**: download React types in `@jupyterlab/` packages +* **Other issues**: delete your node_modules files and reinstall them + ### Backend (logging) extension (optional) If you want to add logging to the project, look in the `src/nb/python` directory. This Python plugin needs to be installed to receive logging requests and save them to file (`~/.jupyter/events.txt`). To register this Python extension in Jupyter notebook or lab, see this guide: https://jupyter-notebook.readthedocs.io/en/latest/extending/handlers.html. As of the time of this writing, installation involves: