Projet SymPy
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- SymPy
- Rédacteur technique:
- Rohit Goswami
- Nom du projet:
- SymEngine
- Durée du projet:
- Durée standard (trois mois)
Project description
Bien que la documentation Sympy soit raisonnablement accessible, la documentation SymEngine est actuellement presque inaccessible. Le code source contient des commentaires, mais ils doivent être reformatés pour une utilisation optimale avec Doxygen. La proposition de projet est de bout en bout et couvre la mise en place d'un pipeline CI pour générer un site Web avec la documentation, ainsi que les améliorations apportées aux documents existants (en termes de couverture et d'exemples de haut niveau). Cela inclut également la récupération des éléments appropriés du wiki et d'autres sources, ainsi que l'ajout d'un guide pour les contributeurs. Le projet mentionne éventuellement l'utilisation de Sphinx, mais je suis personnellement contre cela, car Doxygen s'en sort très bien sans autre traitement (par exemple, https://docs.dseams.info). Cependant, si nécessaire, je suis prêt à configurer d'autres frontaux de consommation. Je souhaite également générer une version PDF de la documentation. Les objectifs ambitieux impliqueront de définir plusieurs exemples spécifiques à Symengine et d'accepter les contributions des utilisateurs. Je voudrais également créer une communauté Zenodo pour Sympy et SymEngine.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/07/25 (UTC)."],[],["The Google Season of Docs project, \"SymEngine,\" involves improving the SymEngine documentation. Key actions include reformatting source code comments for Doxygen, setting up a CI pipeline for a documentation website, and enhancing documentation coverage. It includes incorporating wiki information, creating a contributors guide, and potentially adding Sphinx or other front ends. A PDF version will also be generated. Stretch goals involve adding examples, enabling user contributions, and setting up a Zenodo community for both SymPy and SymEngine. The project will take 3 months.\n"]]
