lincc-frameworks / lincc-frameworks/python-project-template

Cleaner left-hand table-of-contents for API reference

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

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

主要言語
Jinja
スター
85
フォーク
16
平均マージ
6時間 18分
マージ済み PR(30日)
1

説明

Looking at the HATS RTD, the menu options in the left-hand-side for the API reference have a lot of unnecessary duplication:

API reference
└── hats
    ├── hats.catalog
    ├── hats.inspection
    └── ...

I would really love if we could have it be simpler:

hats API reference
├── catalog
├── inspection
└── ... 

this includes the package name in the top-level, and omits the package name from the submodule names.

I don't even know if sphinx/autoapi supports this, but I can dream, right?

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

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

調査の方向性

まず、Read the Docs のドキュメントで API リファレンスを生成している Sphinx/AutoAPI 設定を見つけます。そのオプションで、要求されたトップレベルパッケージ名と、より短いサブモジュールのラベルを生成できるか確認します。レンダリングされた左側のナビゲーションに、パッケージ名を繰り返さず「hats API reference」と「catalog」や「inspection」などのエントリが表示されれば完了です。

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

評価

技術スタック
python
領域
documentation
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

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

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