nbsphinx can't handle links formatted as code

Aperta
#164 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Riproduci la differenza di rendering in docs/how-to-guides/qiskit-circuits.ipynb utilizzando le due forme di link Markdown mostrate nell’issue, quindi esamina il percorso della documentazione nbsphinx/Sphinx coinvolto. L’attività è completata quando il link ffsim.qiskit formattato con i backtick viene renderizzato correttamente nella documentazione Sphinx compilata e rimane un link funzionante.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Example:

The How to build and transpile Qiskit quantum circuits notebook begins with the markdown

In this guide, we show how to use the [ffsim.qiskit](../api/ffsim.qiskit.rst) module to build and transpile fermionic quantum circuits.

which is rendered correctly as

image

However, ideally ffsim.qiskit would be written in code style, ffsim.qiskit. If I try surrounding it in backticks,

In this guide, we show how to use the [`ffsim.qiskit`](../api/ffsim.qiskit.rst) module to build and transpile fermionic quantum circuits.

then it gets rendered incorrectly as

image

The link looks fine in Jupyter, it's just the rendered Sphinx docs that is bad.

Lingua principale
Python
Stelle
116
Fork
50
Merge medio
2h 1m
PR unite (30g)
8

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Qiskit/ffsim

Tutte le issue di Qiskit/ffsim

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.