lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- Jinja
- スター
- 85
- フォーク
- 16
- 平均マージ
- 6時間 18分
- マージ済み PR（30日）
- 1
説明
It would be great if the Read the Docs HTML documentation included buttons to download notebooks (as implemented in the LSDB RTD) and to run the notebooks on Google Colab.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、この template で Read the Docs HTML ドキュメントがどのように生成されるかを確認し、issue で言及されている LSDB RTD 実装と比較します。notebook ページまたはアセットがどこで設定されているかを特定し、生成されたドキュメントに notebook をダウンロードして Google Colab で実行するためのボタンが含まれていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- jupyter-notebook
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100