microsoft/vasim

TODO: setup documentation generation

開放

#5 建立於 2024年8月30日

在 GitHub 查看貢獻者指南
 (1 則留言) (0 個反應) (0 位負責人)Python (7 個分叉)auto 404
TODOdocumentationhelp wanted

倉庫指標

星標
 (12 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

貢獻者指南

研究方向
設置 Sphinx 文檔生成：創建 'docs' 目錄，添加 conf.py、index.rst，並配置 GitHub Pages 或 Read the Docs 部署。
技術棧
python
領域
developer experience
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonSphinx
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80