eclipse-score / eclipse-score/docs-as-code
Sphinx collections cannot be nested
- Langage dominant
- Python
- Étoiles
- 10
- Forks
- 32
- Merge moyen
- 23 h 52 min
- PR mergées (30 j)
- 52
Description
[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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Commencez par la référence en échec docs/_collections/score_docs_as_code/docs/index.rst et le build :docs_combo_experimental dans reference-integration PR 43. Examinez la configuration de sphinx-collections dans docs-as-code et reference-integration, puis évaluez la suppression à court terme et les alternatives à long terme décrites dans l’issue. C’est terminé lorsque les collections imbriquées fonctionnent pour les modules ou que le build ne signale plus le undefined process-collection label.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100