matplotlib / matplotlib/mpl-sphinx-theme
Sidebar template for non-core packages
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 6
- フォーク
- 13
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
The top nav bar is hardcoded into the theme, which works well for `matplotlib/matplotlib`. However, for non-core packages there is no site-wide top level navigation. For `matplotlib/pytest-mpl` I've created a new sidebar template for the top level navigation: https://github.com/matplotlib/pytest-mpl/blob/main/docs/_templates/mpl_third_party_sidebar.html. This sidebar is set to appear above any existing "Section Navigation" sidebars on all pages. https://matplotlib.org/pytest-mpl/latest/index.html
Is this something that should be included in this theme so other non-core packages can have a consistent design? Or maybe you'd rather non-core packages just override the nav bar?
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、既存のテーマナビゲーションを docs/_templates/mpl_third_party_sidebar.html および issue にリンクされているレンダリング済みの pytest-mpl ページと比較します。テーマがコア以外のパッケージにこのサイドバーを提供すべきか、それとも overrides に任せるべきかを確認します。合意したナビゲーション動作が一貫して実装され、文書化されていれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100