Proyecto SymPy

Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.

Resumen del proyecto

Organización de código abierto:
SymPy
Redactor técnico:
Rohit Goswami
Nombre del proyecto:
SymEngine
Duración del proyecto:
Duración estándar (3 meses)

Project description

Si bien la documentación de Sympy es bastante accesible, la de SymEngine actualmente no lo es. Hay comentarios en el código fuente, pero deben volver a formatearse para un mejor uso con Doxygen. La propuesta del proyecto es de extremo a extremo y abarcará la configuración de una canalización de CI para generar un sitio web con la documentación, así como las mejoras en la documentación existente (en términos de cobertura y ejemplos de alto nivel). Esto también incluye tomar los fragmentos adecuados de la wiki y otras fuentes, así como agregar una guía para colaboradores. El proyecto menciona la posibilidad de usar Sphinx, pero personalmente no estoy de acuerdo, ya que Doxygen funciona muy bien sin procesamiento adicional (p.ej., https://docs.dseams.info). Sin embargo, según sea necesario, estoy dispuesto a configurar más frontends para el consumo. También me gustaría generar una versión en PDF de la documentación. Los objetivos adicionales implicarán configurar varios ejemplos específicos de Symengine y permitir que se acepten las contribuciones de los usuarios. También me gustaría configurar una comunidad de Zenodo para Sympy y SymEngine.