Progetto SymPy
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo progetto
- Organizzazione open source:
- SymPy
- Redattore tecnico:
- Rohit Goswami
- Nome del progetto:
- SymEngine
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Sebbene la documentazione di Sympy sia ragionevolmente accessibile, la documentazione di SymEngine è attualmente per lo più inaccessibile. Il codice sorgente contiene commenti, ma questi devono essere riformattati per un uso migliore con Doxygen. La proposta di progetto è end-to-end e riguarderà l'impostazione di una pipeline CI per generare un sito web con la documentazione, nonché i miglioramenti alla documentazione esistente (in termini di copertura ed esempi di alto livello). Sono inclusi anche gli elementi appropriati della wiki e di altre fonti, nonché l'aggiunta di una guida per i collaboratori. Il progetto menziona la possibilità di utilizzare Sphinx, ma sono personalmente contro di questo, dato che Doxygen funziona molto bene senza ulteriore elaborazione (ad es. https://docs.dseams.info). Tuttavia, come richiesto, sono disponibile a configurare più front-end per l'utilizzo. Vorrei anche generare una versione PDF della documentazione. Gli obiettivi sfida prevedono l'impostazione di più esempi specifici di Symengine e la possibilità di accettare i contributi degli utenti. Vorrei anche configurare una community Zenodo sia per Sympy che per SymEngine.
Salvo quanto diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 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"]]
