پروژه Sympy

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.

خلاصه پروژه

سازمان منبع باز:
SymPy
نویسنده فنی:
روهیت گوسوامی
نام پروژه:
SymEngine
طول پروژه:
طول استاندارد (3 ماه)

شرح پروژه

اگرچه اسناد Sympy به طور معقولی در دسترس است، اسناد SymEngine در حال حاضر عمدتاً غیرقابل دسترسی است. نظراتی در کد منبع وجود دارد، اما برای استفاده بهتر با Doxygen باید دوباره قالب بندی شوند. طرح پیشنهادی پروژه سرتاسر است و راه‌اندازی خط لوله CI برای ایجاد یک وب‌سایت با مستندات و همچنین بهبود اسناد موجود (از نظر پوشش و نمونه‌های سطح بالا) را پوشش می‌دهد. این همچنین شامل گرفتن بیت های مناسب از ویکی و سایر منابع و همچنین افزودن راهنمای مشارکت کنندگان است. این پروژه احتمالاً به استفاده از Sphinx اشاره می کند، اما من شخصاً مخالف آن هستم، زیرا Doxygen بدون پردازش بیشتر به خوبی انجام می دهد (به عنوان مثال https://docs.dseams.info). با این حال، همانطور که لازم است، من آماده هستم تا قسمت های جلویی بیشتری را برای مصرف تنظیم کنم. من همچنین می خواهم یک نسخه pdf از اسناد تولید کنم. اهداف توسعه شامل تنظیم چندین مثال خاص Symengine و اجازه دادن به مشارکت کاربران برای پذیرفته شدن است. من همچنین می خواهم یک انجمن Zenodo برای Sympy و SymEngine راه اندازی کنم.