Troubleshooting
Notebooks Won’t Run with VS Code
Run poetry shell
to activate the environment. Then run
code .
in order to open VS Code within the environment. At the
top right of VS Code select the poetry environment (should be something
like ~AppDatalocalpypoetryCachevirtualenvsgnss_lib-<XXXX}Scriptspython.exe
on Windows). Then you should be able to run the notebooks in VS Code.
Note: may need to run poetry add jupyter notebook
in order for
poetry env to be visible in list of VS Code kernels.
No module named *
For example:
Extension error:
Could not import extension nbsphinx (exception: No module named 'nbsphinx')
make: *** [Makefile:20: html] Error 2
It’s possible a new dependency has been added. Verify that you’re in the
right directory (or using the right environment if running a Jupyter
notebook) and update your environment using poetry install
.
build_docs.sh
errors
When running ./build_docs.sh
, it is possible to run into errors
like .build_docs.sh: command not found
.
In this case, try running bash build_docs.sh
instead.
When running ./build_docs.sh
, if you get the message
rm: cannot remove './source/reference/algorithms/*'$'r': No such file or directory
,
the line endings for build_docs.sh
might have changed to CRLF.
Change the line endings to LF and re-run the command.
Pandoc wasn’t found
The following error is possible when building the documentation.
Pandoc wasn't found.
Please check that pandoc is installed:
https://pandoc.org/installing.html
Pandoc is now a dependency for building the documentation. Check the Pandoc installation instructions under the developer installation instructions.