Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Sphinx collections cannot be nested

Abierto
#305 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Error
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
python
Área
documentation

Línea de trabajo

Comienza con la referencia fallida docs/_collections/score_docs_as_code/docs/index.rst y el build :docs_combo_experimental de reference-integration PR 43. Lee cómo se configura sphinx-collections en docs-as-code y reference-integration, y evalúa la eliminación a corto plazo y las alternativas a largo plazo descritas en el issue. Se considera terminado cuando las collections anidadas funcionen para módulos o el build deje de informar del undefined process-collection label.

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

Descripción

When I integrate the docs-as-code module in reference-integration, the :docs_combo_experimental build fails:

/home/runner/work/reference_integration/reference_integration/docs/_collections/score_docs_as_code/docs/index.rst:6: WARNING: undefined label: '_collections/score_process/process/index' [ref.ref]

The problem is the sphinx-collections extension which is used in reference-integration and in docs-as-code. When docs-as-code is not the documentation root, it doesn't find the process collection.

Short-term we can simply remove it from docs-as-code since we only really need it reference-integration currently.

Long-term we want a solution which just works for any module which wants to use it. I see two option: Adapt sphinx-collections to handle such a use-case. Stop using sphinx-collections and implement the combo differently.

Lenguaje dominante
Python
Estrellas
11
Forks
33
Merge medio
22 h 43 min
PR fusionados (30 d)
65

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Más de eclipse-score/docs-as-code

Todos los issues de eclipse-score/docs-as-code

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.