Cleaner left-hand table-of-contents for API reference
还没有人认领这个 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
- 平均合并
- 6 小时 18 分钟
- 30 天内合并 PR
- 1
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
lincc-frameworks/python-project-template 的其他 Issue
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 68/100
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 2/5 1-3 小时 新手友好度 62/100
-
难度 3/5 1-2 天 新手友好度 45/100
lincc-frameworks/python-project-template#600 · 1 条评论 ·
-
enhancement
难度 3/5 1-2 天 新手友好度 58/100
查看 lincc-frameworks/python-project-template 的全部 Issue
相似的 Issue
-
Crush 未关闭
难度 1/5 1 小时以内 新手友好度 85/100
catppuccin/catppuccin#3125 ·
-
automated issue report
难度 1/5 1 小时以内 新手友好度 95/100
-
难度 1/5 1 小时以内 新手友好度 90/100
VoltAgent/awesome-design-md#469 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
KhronosGroup/glTF#2648 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
sccn/sccn.github.io#108 ·