Project SymPy

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.

Ringkasan project

Organisasi open source:
SymPy
Penulis teknis:
Rohit Goswami
Nama project:
SymEngine
Durasi project:
Durasi standar (3 bulan)

Project description

Meskipun dokumentasi Sympy cukup mudah diakses, dokumentasi SymEngine saat ini sebagian besar tidak dapat diakses. Ada komentar dalam kode sumber, tetapi komentar ini perlu diformat ulang agar lebih mudah digunakan dengan Doxygen. Proposal project bersifat menyeluruh dan akan mencakup penyiapan pipeline CI untuk membuat situs dengan dokumentasi, serta peningkatan pada dokumen yang ada (dalam hal cakupan dan contoh tingkat tinggi). Hal ini juga mencakup pengambilan bagian yang sesuai dari wiki dan sumber lainnya, serta menambahkan panduan kontributor. Project ini menyebutkan kemungkinan penggunaan Sphinx, tetapi saya pribadi menentangnya, karena Doxygen berfungsi dengan sangat baik tanpa pemrosesan lebih lanjut (misalnya, https://docs.dseams.info). Namun, sesuai kebutuhan, saya bersedia menyiapkan lebih banyak frontend untuk penggunaan. Saya juga ingin membuat versi PDF dokumentasi. Sasaran perpanjangan akan melibatkan penetapan beberapa contoh khusus Symengine dan memungkinkan kontribusi pengguna diterima. Saya juga ingin menyiapkan komunitas Zenodo untuk Sympy dan SymEngine.