SymPy 專案

本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。

專案摘要

開放原始碼組織：

SymPy

技術撰稿人：

Rohit Goswami

專案名稱：

SymEngine

專案長度：

標準長度 (3 個月)

Project description

雖然 Sympy 說明文件相當容易取得，但 SymEngine 說明文件目前大多無法取得。原始碼中含有註解，但需要重新格式化，才能更妥善地與 Doxygen 搭配使用。專案提案是端對端的，將涵蓋設定持續整合管道，以便產生說明文件網站，以及改善現有說明文件 (涵蓋範圍和高層級範例)。這也包括從維基百科和其他來源擷取適當的內容，以及新增貢獻者指南。這個專案提到可能使用 Sphinx，但我個人反對，因為 Doxygen 根本沒有進一步處理而已 (例如 https://docs.dseams.info)。不過，我可以視需求設定更多前端供使用。我也想產生說明文件的 PDF 版本。延伸目標將涉及設定多個 Symengine 專屬範例，並允許接受使用者貢獻。我也想為 Sympy 和 SymEngine 建立 Zenodo 社群。