python / python/peps

Infra: errors blocking migration towards docutils 0.22+

Abierto
#4,924 6 comentarios 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

infra
Lenguaje dominante
reStructuredText
Estrellas
5k
Forks
1.8k
Merge medio
2 d 4 h
PR fusionados (30 d)
25

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza reproduciendo la compilación paralela de Sphinx con Sphinx 9.1.0 y docutils 0.22.4; después, inspecciona las ubicaciones indicadas en peps/pep-0554.rst, pep-0683.rst, pep-0426.rst, pep-0653.rst, pep-0827.rst, pep-0697.rst y pep-0791.rst. Se considera terminado cuando los errores y advertencias de docutils indicados ya no hacen que la compilación falle de forma irrecuperable, preservando el contenido de los PEP.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Área
build-system, documentation
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Activo
Claridad
Bastante claro
Aptitud para principiantes
55/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.