SymPy project
Stay organized with collections
Save and categorize content based on your preferences.
This page contains the details of a technical writing project accepted for
Google Season of Docs.
Project summary
- Open source organization:
- SymPy
- Technical writer:
- Rohit Goswami
- Project name:
- SymEngine
- Project length:
- Standard length (3 months)
Project description
Though the Sympy documentation is reasonably accessible, the SymEngine documentation is currently mostly in-accessible. There are comments in the source code, but these need to be re-formatted for better use with Doxygen. The project proposal is end-to-end and will cover setting up a CI pipeline for generating a website with the documentation, as well as improvements to the existing docs (in terms of coverage and high level examples). This also includes taking appropriate bits from the wiki and other sources, as well as adding a contributors guide. The project mentions possibly using Sphinx but I am personally against that, as Doxygen does very well without further processing (e.g. https://docs.dseams.info). However, as required, I am open to setting up more front ends for consumption. I would also like to generate a pdf version of the documentation. The stretch goals will involve setting multiple Symengine specific examples and allowing for user contributions to be accepted. I would also like to set up a Zenodo community for both Sympy and SymEngine.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 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"]]
