Infra: errors blocking migration towards docutils 0.22+
まだ誰も着手していません。
- 主要言語
- reStructuredText
- スター
- 5k
- フォーク
- 1.8k
- 平均マージ
- 2日 4時間
- マージ済み PR(30日)
- 25
説明
Following the work in #4087, I have decided to investigate possible issues with going further, towards docutils 0.22+. The following are extracts from the errors failing the build process (tested on Sphinx 9.1.0 and docutils 0.22.4). I have error logs with full tracebacks and more details available if needed.
Errors
peps/pep-0554.rst:29: (ERROR/3) Indirect hyperlink target (id="concurrency") refers to target "concurrency", which is a duplicate, and cannot be used as a unique reference.peps/pep-0683.rst:476: (ERROR/3) Indirect hyperlink target (id="documentation") refers to target "documentation", which is a duplicate, and cannot be used as a unique reference.peps/pep-0426.rst:748: (ERROR/3) Duplicate target name, cannot be used as a unique reference: "extras".peps/pep-0653.rst:722: (WARNING/2) Footnote content expected.peps/pep-0827.rst:1963: (WARNING/2) Footnote content expected.peps/pep-0697.rst:250: (ERROR/3) Indirect hyperlink target (id="reference-implementation") refers to target "reference implementation", which is a duplicate, and cannot be used as a unique reference.peps/pep-0791.rst:163: (ERROR/3) Indirect hyperlink target (id="id1") refers to target "motivation", which is a duplicate, and cannot be used as a unique reference.
All of those errors are coming from docutils, not from Sphinx, but they are hard-failing the parallel Sphinx builds.
CC @hugovk
EDIT: After investigation, only docutils is blocked. Sphinx 9 works fine.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、Sphinx 9.1.0 と docutils 0.22.4 を使用した並列 Sphinx ビルドを再現し、その後 peps/pep-0554.rst、peps/pep-0683.rst、peps/pep-0426.rst、peps/pep-0653.rst、peps/pep-0827.rst、peps/pep-0697.rst、peps/pep-0791.rst の報告された箇所を調査します。列挙された docutils のエラーと警告によってビルドがハードフェイルせず、PEP の内容が維持されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- build-system, documentation
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 55/100