pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2,503 建立於 2024年5月27日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Python (383 fork)batch import
enhancementhelp wanted

倉庫指標

Star
 (4,528 star)
PR 合併指標
 (平均合併 1天 15小時) (30 天內合併 5 個 PR)

描述

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

貢獻者指南

研究方向
使用 numpydoc 格式從文件字串自動產生文件並發佈到 GitHub Pages。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonGit
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75