pymc-labs/CausalPy

Improve docs through increased use of intersphinx

Open

#236 opened on 2023年9月11日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (111 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1,162 stars)
PR merge metrics
 (PR metrics pending)

説明

  1. Add more intersphinx mappings in conf.py: 
    "pandas": ("https://pandas.pydata.org/docs/", None),
"scikit-learn": ("https://scikit-learn.org/stable/", None),
    And also arviz when referring to idata for example.
  2. Use external intersphinx references when referring to external classes/functions. E.g. https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external

コントリビューターガイド

調査方針
issueに示されているようにconf.pyにintersphinxマッピングを追加し、ドキュメントで外部参照を使用します。Sphinx intersphinxドキュメントを参照してください。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Python
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
85