eclipse-score / eclipse-score/docs-as-code

Sphinx collections cannot be nested

Aperta
#305 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
10
Fork
32
Merge medio
23h 52m
PR unite (30g)
52

Descrizione

[When I integrate the docs-as-code module in reference-integration](https://github.com/eclipse-score/reference_integration/pull/43), 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](https://sphinx-collections.readthedocs.io/en/latest/) 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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.