פרויקט 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.