search

CQCL / pytket-docs

User manual and example notebooks for the pytket quantum computing toolkit
https://docs.quantinuum.com/tket/user-guide/
Apache License 2.0
331 stars 90 forks source link

Port manual source material to MyST markdown #366

Closed CalMacCQ closed 1 month ago

CalMacCQ commented 2 months ago

This would allow us to use the MyST-NB library to build html pages for both the manual and examples.

Currently the manual is built with jupyter-sphinx and the examples with MyST-NB which leads to some visual inconsistency in the code snippets between the two.

There are automated tools for doing the conversion

rst-to-myst -> https://github.com/executablebooks/rst-to-myst myst-parser -> https://github.com/executablebooks/myst-parser