Sphinx collections cannot be nested
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- バグ
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
調査の方向性
失敗している参照 docs/_collections/score_docs_as_code/docs/index.rst と、reference-integration PR 43 にある :docs_combo_experimental build から始めてください。docs-as-code と reference-integration で sphinx-collections がどのように設定されているかを確認し、そのうえで issue に記載されている短期的な削除と長期的な代替案を評価してください。モジュールでネストされた collections が機能するか、または build が undefined process-collection label を報告しなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- Python
- スター
- 11
- フォーク
- 33
- 平均マージ
- 22時間 43分
- マージ済み PR（30日）
- 65
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
eclipse-score/docs-as-code のほかの issue
-
good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
eclipse-score/docs-as-code#850 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
eclipse-score/docs-as-code#771 · 担当者 1 名 ·
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
eclipse-score/docs-as-code#613 · コメント 1 件 ·
-
update py_venv オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
eclipse-score/docs-as-code#606 ·
-
bug waiting_for_author
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
eclipse-score/docs-as-code#288 · コメント 2 件 ·
eclipse-score/docs-as-code の issue をすべて見る
似ている issue
-
area: harness bug status: needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
Human-Agent-Society/reef#625 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 80/100
learningequality/kolibri#15351 · コメント 2 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
Name consistency オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
eellak/triplestore#65 · コメント 1 件 ·