Docs: Added troubleshooting notes

This commit is contained in:
Andrew Head 2019-02-04 14:48:11 -08:00 коммит произвёл GitHub
Родитель b592b4cfdf
Коммит 0ea8b995e9
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
1 изменённых файлов: 9 добавлений и 2 удалений

Просмотреть файл

@ -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: