Cleaner left-hand table-of-contents for API reference
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 38/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- python
研究方向
先找出 Read the Docs 文件中產生 API 參考的 Sphinx/AutoAPI 設定。檢查其選項是否能產生所要求的頂層套件名稱，以及較短的子模組標籤。當呈現後的左側導覽顯示「hats API reference」，並包含「catalog」和「inspection」等項目，且不重複套件名稱時，即表示完成。
由索引模型根據 Issue 內容生成。
描述
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?
- 主要語言
- Jinja
- 星號
- 85
- 分支
- 16
- 平均合併
- 21 小時 19 分鐘
- 30 天內合併 PR
- 15
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 沒有貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
lincc-frameworks/python-project-template 的其他 Issue
-
documentation good first issue
難度 2/5 1-3 小時 新手友好度 68/100
lincc-frameworks/python-project-template#589 ·
維護者通常 1 天內回覆
-
Add a few "base" pre-commit hooks可能重新可做 關聯的 PR 已關閉且未合併。 未關閉
難度 2/5 1-3 小時 新手友好度 62/100
lincc-frameworks/python-project-template#574 · 1 則留言 ·
維護者通常 1 天內回覆
-
enhancement
難度 2/5 1-3 小時 新手友好度 55/100
lincc-frameworks/python-project-template#620 ·
維護者通常 1 天內回覆
-
難度 3/5 1-2 天 新手友好度 45/100
lincc-frameworks/python-project-template#605 ·
維護者通常 1 天內回覆
-
enhancement
難度 3/5 1-2 天 新手友好度 58/100
lincc-frameworks/python-project-template#588 ·
維護者通常 1 天內回覆
查看 lincc-frameworks/python-project-template 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 85/100
aws-samples/sample-per-model-bedrock#321 ·
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 68/100
FavioVazquez/showtime#101 ·
維護者通常 1 天內回覆
-
tech-debt
難度 2/5 半天 新手友好度 88/100
維護者通常 1 天內回覆
-
バグ・誤り・不備
難度 2/5 1-3 小時 新手友好度 65/100
lean-ja/lean-by-example#2641 ·
-
agent-butler-finding chore
難度 1/5 1 小時以內 新手友好度 90/100
jordansmall/spindrift#5575 ·
維護者通常 1 天內回覆