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