โปรเจ็กต์ SymPy

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส:

SymPy

นักเขียนเชิงเทคนิค

Rohit Goswami

ชื่อโปรเจ็กต์:

SymEngine

ระยะเวลาของโปรเจ็กต์

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

แม้ว่าเอกสารประกอบของ Sympy จะเข้าถึงได้ค่อนข้างง่าย แต่ปัจจุบันเอกสารประกอบของ SymEngine ส่วนใหญ่จะเข้าถึงไม่ได้ มีความคิดเห็นในซอร์สโค้ด แต่ต้องจัดรูปแบบใหม่เพื่อให้ใช้กับ Doxygen ได้ดียิ่งขึ้น ข้อเสนอโปรเจ็กต์เป็นแบบต้นทางถึงปลายทางและจะครอบคลุมการตั้งค่าไปป์ไลน์ CI เพื่อสร้างเว็บไซต์พร้อมเอกสารประกอบ ตลอดจนการปรับปรุงเอกสารที่มีอยู่ (ในแง่ความครอบคลุมและตัวอย่างระดับสูง) ซึ่งรวมถึงการนำข้อมูลบางส่วนจากวิกิและแหล่งที่มาอื่นๆ ตลอดจนเพิ่มคู่มือสำหรับผู้มีส่วนร่วม โปรเจ็กต์พูดถึงการใช้ Sphinx แต่ส่วนตัวแล้วเราไม่แนะนำ เนื่องจาก Doxygen ทำงานได้ดีมากโดยไม่ต้องประมวลผลเพิ่มเติม (เช่น https://docs.dseams.info) อย่างไรก็ตาม เรายินดีที่จะตั้งค่าส่วนหน้าเพิ่มเติมสำหรับการบริโภคตามที่จำเป็น ฉันต้องการสร้างเอกสารเวอร์ชัน PDF ด้วย เป้าหมายการขยายจะเกี่ยวข้องกับการตั้งค่าตัวอย่างเฉพาะ Symengine หลายรายการ และเปิดโอกาสให้ผู้ใช้ยอมรับการมีส่วนร่วมของผู้ใช้ นอกจากนี้ เรายังต้องการสร้างชุมชน Zenodo สำหรับทั้ง Sympy และ SymEngine ด้วย