QuTech-Delft / quantuminspire

Quantum Inspire SDK
Apache License 2.0
65 stars 27 forks source link

[SDS-NNN] Changes needed to display correct html again #127

Closed QFer closed 2 years ago

QFer commented 2 years ago
coveralls commented 2 years ago

Coverage Status

Coverage remained the same at 100.0% when pulling 8898c8c530c7ea940ad61bd164bb3294bc9c7200 on fix/SDS-NNN/read_the_docs_html_fix into 3ef709ecba2d3c8194fc334d537bcd690f9ccbf0 on dev.

rhjdjong commented 2 years ago

Building the documentation on windows fails, because pandoc is not installed by default:

> pip install -e .[rtd]
> cd docs
> make html
Running Sphinx v4.3.2
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 20 source files that are out of date
updating environment: [new config] 20 added, 0 changed, 0 removed
reading sources... [ 25%] examples/example_projectq                            
Notebook error:
PandocMissing in examples\example_projectq.ipynb:
Pandoc wasn't found.
Please check that pandoc is installed:
https://pandoc.org/installing.html

pip install pandoc only installs the python wrapper functions for the pandoc executable. The actual pandoc executable must have been installed already in the system. This should be mentioned in the README. After installing pandoc via the website mentioned in the message, the documentation build succeeds.