SymPy 项目

本页面包含 Google 文档季接受的技术写作项目的详细信息。

项目摘要

开源组织：

SymPy

技术文档工程师：

Rohit Goswami

项目名称：

SymEngine

项目时长：

标准时长（3 个月）

Project description

虽然 Sympy 文档的访问性还算不错，但 SymEngine 文档目前大部分无法访问。源代码中有注释，但这些注释需要重新调整格式，以便更好地与 Doxygen 一起使用。该项目提案是端到端的，将涵盖设置 CI 流水线以生成包含文档的网站，以及对现有文档进行改进（在覆盖率和概要示例方面）。这还包括从维基百科和其他来源中提取适当的内容，以及添加贡献者指南。该项目提到可能会使用 Sphinx，但我个人不赞成这样做，因为 Doxygen 无需进一步处理即可发挥出色效果（例如 https://docs.dseams.info）。不过，根据需要，我可以设置更多前端来进行使用。我还希望生成文档的 PDF 版本。延伸目标包括设置多个特定于 Symengine 的示例，并允许用户贡献内容。我还希望为 Sympy 和 SymEngine 创建一个 Zenodo 社区。