qiskit-tutorials icon indicating copy to clipboard operation
qiskit-tutorials copied to clipboard

The tutorials must be able to have syntaxes that can be converted to rst.

Open SooluThomas opened this issue 4 years ago • 1 comments

For example, the generated docs for the pulse tutorials (https://qiskit.org/documentation/tutorials/pulse/2_building_pulse_instructions.html#Building-Pulse-Instructions) image

  • Sphinx doesn't support ``literal`` emphasizing within external hyperlinks. For example ```Delay(duration: int, channel)`` <#delay>`__

  • We also might want to figure out how internal hyperlinks can be used interchangeably in both the tutorials and sphinx generated docs. Because "#delay" adds hyperlink in .ipynb/markdown but it doesn't do the same when converted to .rst.

SooluThomas avatar Aug 11 '20 01:08 SooluThomas

Hey @SooluThomas I think this is fixed. You can close this issue

divshacker avatar Jun 08 '21 09:06 divshacker

It's possible to use RST with notebooks: https://nbsphinx.readthedocs.io/en/0.5.0/raw-cells.html

Eric-Arellano avatar Aug 18 '23 16:08 Eric-Arellano