SymPy-Projekt
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- SymPy
- Technischer Redakteur:
- Rohit Goswami
- Projektname:
- SymEngine
- Projektlänge:
- Standardlänge (3 Monate)
Projektbeschreibung
Obwohl die Sympy-Dokumentation einigermaßen zugänglich ist, ist die SymEngine-Dokumentation derzeit größtenteils nicht zugänglich. Der Quellcode enthält Kommentare, die für eine bessere Verwendung mit Doxygen neu formatiert werden müssen. Der Projektvorschlag ist ein End-to-End-Vorschlag und umfasst die Einrichtung einer CI-Pipeline zum Generieren einer Website mit der Dokumentation sowie Verbesserungen an den vorhandenen Dokumenten (in Bezug auf Abdeckung und allgemeine Beispiele). Dazu gehört auch, geeignete Informationen aus dem Wiki und anderen Quellen zu übernehmen und einen Leitfaden für Mitwirkende hinzuzufügen. Im Projekt wird möglicherweise die Verwendung von Sphinx erwähnt, aber ich bin persönlich dagegen, da Doxygen ohne weitere Verarbeitung sehr gut funktioniert (z.B. https://docs.dseams.info). Ich bin jedoch bereit, bei Bedarf weitere Front-Ends für die Nutzung einzurichten. Ich möchte auch eine PDF-Version der Dokumentation generieren. Die Stretch-Ziele umfassen die Definition mehrerer Symengine-spezifischer Beispiele und die Akzeptanz von Nutzerbeiträgen. Außerdem möchte ich eine Zenodo-Community sowohl für Sympy als auch für SymEngine einrichten.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 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"]]
