Intersphinx links to related docs esp. API pages

オープン
#162 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

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

調査の方向性

Start with the intersphinx configuration in docs/source/conf.py at the linked lines, then search the documentation for references and links to NumPy, matplotlib, cartopy, and other related libraries. Convert external documentation references to intersphinx links; the work is done when the relevant references are converted and the docs build successfully.

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

説明

docs

In 25288ba I set up docs external project linking using the intersphinx Sphinx extension:

https://github.com/NCAS-CMS/cf-plot/blob/ad190e2748d2cbec9906d4c7c992e8a5e34f3da5/docs/source/conf.py#L59-L63

but apart from one case I haven't gone through the docs to convert any references and links to other related libraries and dependencies e.g. NumPy, matplotlib, cartopy, etc. These should be searched for and converted, then going forward any reference to external docs should be linked via intersphinx means rather than as a standard RST link.

主要言語
Python
スター
21
フォーク
11
平均マージ
2日 21時間
マージ済み PR(30日)
7

環境構築

はじめの一歩

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

NCAS-CMS/cf-plot のほかの issue

NCAS-CMS/cf-plot の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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