Docs: use linkcheck build to verify external links
オープン
まだ誰も着手していません。
documentation
- 主要言語
- Python
- スター
- 150
- フォーク
- 23
- 平均マージ
- 1日 11時間
- マージ済み PR（30日）
- 2
説明
As part of our release process we manually test links e.g. to the relevant sections in the CF conventions. This check can be largely automated (all but fixing incorrect links) by running the sphinx.builders.linkcheck builder which detects broken links and raises warnings if they are found.
Addressing this will help towards automation of the release process (see #134).
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
ファイルやテストは指定されていません。まず Sphinx ドキュメントのビルド設定とリリースプロセスへの参照を見つけ、次に linkcheck builder のドキュメントを確認してください。リリースドキュメントのビルドで外部リンクがチェックされ、壊れたリンクが警告として報告され、手動でリンクをテストする必要がなければ完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation, release
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100