lundybernard/batconf

Cleanup Sphinx documentation

开放

#32 创建于 2024年7月27日

在 GitHub 查看
 (1 条评论) (0 个反应) (0 位负责人)Python (3 个派生)auto 404
good first issue

仓库指标

星标
 (5 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

The documentation needs to be reviewed and cleaned up. Feel free to take on smaller tasks and open new Issues to track them.

Some things that need improvement:

  • Auto-generated API documentation
  • Add a detailed User Guide
  • Enable make docs from the project's root directory, so we don't need to cd into docs/

贡献者指南

研究方向
审查现有的Sphinx文档，找出自动生成的API文档和用户指南的差距，并按建议进行改进。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75