Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Sphinx collections cannot be nested

Aperta
#305 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Bug
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Inizia con il riferimento che fallisce docs/_collections/score_docs_as_code/docs/index.rst e il build :docs_combo_experimental in reference-integration PR 43. Leggi come è configurato sphinx-collections in docs-as-code e reference-integration, quindi valuta la rimozione a breve termine e le alternative a lungo termine descritte nell’issue. Il lavoro è completato quando le collections annidate funzionano per i moduli oppure il build non segnala più il undefined process-collection label.

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

Descrizione

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.

Lingua principale
Python
Stelle
11
Fork
33
Merge medio
22h 43m
PR unite (30g)
65

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 eclipse-score/docs-as-code

Tutte le issue di eclipse-score/docs-as-code

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.