Include example notebooks in documentation

[gamatos]

It would be nice if the example notebooks could be embedded directly in the documentation so that the user does not have to look at them in the repository.

Ideally we would have the examples both in the documentation for easy reference and better presentation and in notebook form in case the user wants to execute the code.

[CalMacCQ]

Hi,

The pytket-qujax notebooks are currently built and deployed as part of the pytket examples jupyterbook https://tket.quantinuum.com/examples/pytket-qujax_qaoa.html

I think its a good idea to move the example notebooks as part of the API documentation. For instance you could use jupyter-execute:: cells in .rst files. We already do this in the pytket user manual. This is also easier to review in PRs than big notebook files.

Longer term I'm thinking I'll phase out the examples repository and consolidate the content into the user manual.