lincc-frameworks / lincc-frameworks/python-project-template
RTD template: switch to sphinx_book_theme HTML theme
オープン
まだ誰も着手していません。
enhancement
- 主要言語
- Jinja
- スター
- 85
- フォーク
- 16
- 平均マージ
- 6時間 18分
- マージ済み PR(30日)
- 1
説明
sphinx_book_theme is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずテンプレート内の Read the Docs 設定を見つけ、関連する要件について issues #518 と #500 を確認します。現在の HTML テーマがどのように選択されているかを確認し、生成されるプロジェクトで一貫して sphinx_book_theme が使用されるようにテンプレートを更新します。完了の条件は、新しいテーマでドキュメントをビルドできることです。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100