lincc-frameworks / lincc-frameworks/python-project-template
RTD template: add buttons to download and run notebooks
未关闭
还没有人认领这个 Issue。
enhancement
- 主要语言
- Jinja
- 星标
- 85
- 派生
- 16
- 平均合并
- 6 小时 18 分钟
- 30 天内合并 PR
- 1
描述
It would be great if the Read the Docs HTML documentation included buttons to download notebooks (as implemented in the LSDB RTD) and to run the notebooks on Google Colab.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先检查此模板中 Read the Docs HTML 文档的生成方式，并将其与 issue 中提到的 LSDB RTD 实现进行比较。确定 notebook 页面或资产的配置位置，然后验证生成的文档是否包含用于下载 notebook 和在 Google Colab 中运行它们的按钮。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- jupyter-notebook
- 领域
- documentation
- Issue 类型
- 功能
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100