SymPy project

This page contains the details of a technical writing project accepted for Season of Docs.

Project summary

Open source organization:
SymPy
Technical writer:
Rohit Goswami
Project name:
SymEngine
Project length:
Long running (5 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.