lincc-frameworks / lincc-frameworks/python-project-template
Cleaner left-hand table-of-contents for API reference
未關閉
還沒有人認領這個 Issue。
- 主要語言
- Jinja
- 星號
- 85
- 分支
- 16
- 平均合併
- 6 小時 18 分鐘
- 30 天內合併 PR
- 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?
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先找出 Read the Docs 文件中產生 API 參考的 Sphinx/AutoAPI 設定。檢查其選項是否能產生所要求的頂層套件名稱,以及較短的子模組標籤。當呈現後的左側導覽顯示「hats API reference」,並包含「catalog」和「inspection」等項目,且不重複套件名稱時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- python
- 領域
- documentation
- Issue 類型
- 功能
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 38/100