SymPy プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:

SymPy

テクニカル ライター:

Rohit Goswami

プロジェクト名:

SymEngine

プロジェクトの長さ:

標準期間（3 か月）

プロジェクトの説明

Sympy のドキュメントは比較的アクセスしやすいですが、SymEngine のドキュメントは現在ほとんどアクセスできません。ソースコードにはコメントがありますが、これらを Doxygen で使いやすくするには再フォーマットする必要があります。プロジェクトの提案はエンドツーエンドであり、ドキュメントを含むウェブサイトを生成するための CI パイプラインの設定と、既存のドキュメントの改善（カバレッジと概要の例）を対象としています。これには、ウィキやその他のソースから適切な部分を抜粋することや、コントリビューター ガイドを追加することも含まれます。このプロジェクトでは Sphinx を使用する可能性について言及されていますが、個人的には、Doxygen は追加の処理なしで非常に優れているため、Sphinx の使用には反対です（例: https://docs.dseams.info）。ただし、必要に応じて、ご利用いただけるフロントエンドを追加することも可能です。ドキュメントの PDF 版も生成したいのですが、ストレッチ目標では、Symengine 固有の複数のサンプルを設定し、ユーザーの貢献を受け入れることを想定しています。また、Sympy と SymEngine の両方について Zenodo コミュニティを設定したいと考えています。