Add pytket extensions index page to pytket API docs #1105
Conversation
|
Looks like there are some warnings from duplicate links that are casuing the docs build to fail on ubuntu. https://github.com/CQCL/tket/actions/runs/6710330796/job/18235282076?pr=1105 EDIT: now solved in 8999f27. |
pytket/docs/index.rst
Outdated
|
|
||
| .. toctree:: | ||
| :caption: More Documentation: | ||
| :maxdepth: 1 | ||
|
|
||
| Manual <https://cqcl.github.io/pytket/manual/index.html> | ||
| Extensions <https://cqcl.github.io/pytket-extensions/api/index.html> | ||
| extensions_index.rst |
There was a problem hiding this comment.
Have you checked if this is showing up as intended? Do we want to update the links back from the extensions to this overview as well?
There was a problem hiding this comment.
Here's what it looks like before and after I click (see images below). I would like to avoid the dropdown as this looks really bad.
Any ideas how to fix this?
I've tried the following
.. toctree::
:caption: More Documentation:
:maxdepth: 0
But that doesn't work
There was a problem hiding this comment.
The dropdown looks not like the best solution, but showing them always is taking a lot of space also... Do you have any other ideas how to handle this?
|
|
||
| QPUs | ||
| ==== | ||
| `IBMQBackend <https://tket.quantinuum.com/extensions/pytket-qiskit/api.html#pytket.extensions.qiskit.IBMQBackend>`_ |
There was a problem hiding this comment.
In which order are the QPUs sorted here?
There was a problem hiding this comment.
They are now in this order
I have now put Quantinuum first and mentioned that H2-1 is supported and H1-2 is not. Is this correct?
There was a problem hiding this comment.
I thought they are all three now available? I think we should list all three
There was a problem hiding this comment.
H1-2 is retired from my understanding.
Is there another one besides H1-1 and H2-1?
There was a problem hiding this comment.
I think the H1-2 can be left out.
Currently the pytket-extensions repo currently only contains the source for a single documentation page.
I was going to put this page in the
tket-siterepository but this requires adding an additonal build stage. I think that adding a whole extra build for a single index page is a bit overkillI think it is much simpler to just have the extensions index as part of the pytket API docs. This is already linked from the API docs anyway.
Note that most of the links go to the relevant API docs at the https://tket.quantinuum.com domain.
The pytket-qujax, pytket-ionq, pytket-aqt and pytket-qsharp docs are not yet built on the website so the links for these extensions go to the cqcl.github.io site.