python / python/peps

PEP 12: Add list of intersphinx mappings

オープン
#4,610 コメント 2 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
reStructuredText
スター
5k
フォーク
1.8k
平均マージ
2日 4時間
マージ済み PR(30日)
25

説明

PEP 12 is very helpful in writing PEPs and has a section on intersphinx. However, to know the available intersphinx mappings, one has to know where to look in the sphinx configuration.

I think it would be useful to include the list directly in PEP 12.

Alternatively, if that is considered to be at too high a risk for getting outdated, one could add an explanation on where to find it.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、PEP 12 と issue で参照されている Sphinx 設定の場所を特定します。intersphinx のマッピングがどこで管理されているかを確認し、その後、PEP 12 を一覧で更新するか、読者がその一覧を見つけられる場所を説明します。完了とは、設定に関する予備知識がなくても利用可能なマッピングを見つけられる状態を意味します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
48/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。