bavovanachte / sphinx-wavedrom

A sphinx extension that allows including wavedrom diagrams by using its text-based representation
MIT License
32 stars 18 forks source link

Error verbosity in case wavedrom-cli is not found #35

Closed bavovanachte closed 2 years ago

bavovanachte commented 3 years ago

Fix proposal for #34

Tested in a docker environment with the following output

$ make html
sphinx-build -b html -d build/doctrees  -W source build/html
Running Sphinx v3.2.1
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index                                                                                                                                                                                          
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index                                                                                                                                                                                           
Sphinx error:

Wavedrom command 'npx wavedrom-cli' cannot be run. Versions >3.0.0 use wavedrom-cli as the default rendering engine for the diagrams,
which may not be available or installable on your system.
A pure python wavedrom implementation (wavedrompy) is available as backup option and can be activated by configuring
"render_using_wavedrompy = True" in your conf.py. However, be aware that its results may differ from the official
wavedrom tool

make: *** [Makefile:64: html] Error 2
imphil commented 3 years ago

LGTM, thanks!