python / python/peps

Infra: errors blocking migration towards docutils 0.22+

Aperta
#4,924 6 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

infra
Lingua principale
reStructuredText
Stelle
5k
Fork
1.8k
Merge medio
2g 4h
PR unite (30g)
25

Descrizione

Following the work in #4087, I have decided to investigate possible issues with going further, towards docutils 0.22+. The following are extracts from the errors failing the build process (tested on Sphinx 9.1.0 and docutils 0.22.4). I have error logs with full tracebacks and more details available if needed.

Errors

  • peps/pep-0554.rst:29: (ERROR/3) Indirect hyperlink target (id="concurrency") refers to target "concurrency", which is a duplicate, and cannot be used as a unique reference.
  • peps/pep-0683.rst:476: (ERROR/3) Indirect hyperlink target (id="documentation") refers to target "documentation", which is a duplicate, and cannot be used as a unique reference.
  • peps/pep-0426.rst:748: (ERROR/3) Duplicate target name, cannot be used as a unique reference: "extras".
  • peps/pep-0653.rst:722: (WARNING/2) Footnote content expected.
  • peps/pep-0827.rst:1963: (WARNING/2) Footnote content expected.
  • peps/pep-0697.rst:250: (ERROR/3) Indirect hyperlink target (id="reference-implementation") refers to target "reference implementation", which is a duplicate, and cannot be used as a unique reference.
  • peps/pep-0791.rst:163: (ERROR/3) Indirect hyperlink target (id="id1") refers to target "motivation", which is a duplicate, and cannot be used as a unique reference.

All of those errors are coming from docutils, not from Sphinx, but they are hard-failing the parallel Sphinx builds.

CC @hugovk

EDIT: After investigation, only docutils is blocked. Sphinx 9 works fine.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia riproducendo la build parallela di Sphinx con Sphinx 9.1.0 e docutils 0.22.4, quindi esamina le posizioni segnalate in peps/pep-0554.rst, peps/pep-0683.rst, peps/pep-0426.rst, peps/pep-0653.rst, peps/pep-0827.rst, peps/pep-0697.rst e peps/pep-0791.rst. Il lavoro è completato quando gli errori e gli avvisi docutils elencati non causano più il fallimento bloccante della build, preservando il contenuto dei PEP.

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

Valutazione

Ambito
build-system, documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.