search

QuTech-Delft / OpenQL

OpenQL: A Portable Quantum Programming Framework for Quantum Accelerators. https://dl.acm.org/doi/10.1145/3474222
https://openql.readthedocs.io
Other
99 stars 44 forks source link

Add documentation file for the visualizer #355

Closed tmeer closed 3 years ago

tmeer commented 3 years ago

Added a rough draft for the documentation of the visualizer, explaining its usage.

Also contains a restructuring of the code that handles positioning elements on the image.

jvanstraten commented 3 years ago

To make the visualizer page appear on readthedocs you'll have to add it to the index file. Otherwise I see no immediate problems as long as the docs compile, but I didn't check extensively yet.

tmeer commented 3 years ago

To make the visualizer page appear on readthedocs you'll have to add it to the index file. Otherwise I see no immediate problems as long as the docs compile, but I didn't check extensively yet.

Added it to the index file.

jvanstraten commented 3 years ago

Checking a bit more thoroughly now that I have my dev environment open; make sure to run make html in the docs folder to ensure everything works by the way (you'll need to install sphinx using pip3 and maybe some other packages if it complains, but it shouldn't give you any trouble otherwise). Among many other things from other people who apparently did not do this or ignore the output, you'll find

.../docs/visualizer.rst:139: WARNING: Could not lex literal_block as "json". Highlighting skipped.

because you can't open a JSON block with an object entry; you need {} around the whole thing to make it work.

I thought these PRs were going into develop though? Going through a separate branch on the main OpenQL repo before going to develop seems redundant to me, but whatever.

Entirely unrelated, I sent you an e-mail earlier this week asking for a picture of you to put in the slides for the Intel review presentation. I'm not sure you saw? (Or maybe I used the wrong address?) I have everyone else's pictures already, so it's the only thing I have left to do to finish my slides.

tmeer commented 3 years ago

I get a giant list of errors when I try to generate the docs (I suppose from missing other packages, I'll fix that later), but if the above is the only warning the visualizer doc file gives on your properly set up environment, that warning should be fixed now.

Your e-mail slipped my mind, I'll message you today.