lincc-frameworks / lincc-frameworks/python-project-template
RTD template: switch to sphinx_book_theme HTML theme
未关闭
还没有人认领这个 Issue。
enhancement
- 主要语言
- Jinja
- 星标
- 85
- 派生
- 16
- 平均合并
- 6 小时 18 分钟
- 30 天内合并 PR
- 1
描述
sphinx_book_theme is used by hats/hats-import/lsdb/nested-pandas and it is really nice, let's use it for everything! It would probably help with #518 and #500
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先定位模板中的 Read the Docs 配置,并查看 issue #518 和 #500,了解相关要求。检查当前 HTML 主题的选择方式,并更新模板,使生成的项目始终使用 sphinx_book_theme;完成标准是文档能够使用新主题构建。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 35/100