Projeto SymPy

Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.

Resumo do projeto

Organização de código aberto:
SymPy
Redator técnico:
Rohit Goswami
Nome do projeto:
SymEngine
Duração do projeto:
Duração padrão (três meses)

Project description

Embora a documentação do Sympy seja razoavelmente acessível, a documentação do SymEngine atualmente não é acessível. Há comentários no código-fonte, mas eles precisam ser formatados novamente para uso com o Doxygen. A proposta do projeto é completa e abrange a configuração de um pipeline de CI para gerar um site com a documentação, bem como melhorias nos documentos atuais (em termos de cobertura e exemplos de alto nível). Isso também inclui usar partes adequadas da wiki e de outras fontes, além de adicionar um guia para colaboradores. O projeto menciona a possibilidade de usar o Sphinx, mas eu pessoalmente contra isso, porque o Doxygen faz muito bem sem processamento adicional (por exemplo, https://docs.dseams.info). No entanto, se necessário, estou disposto a configurar mais front-ends para consumo. Também gostaria de gerar uma versão em PDF da documentação. As metas de alongamento vão envolver a definição de vários exemplos específicos do Symengine e a aceitação de contribuições dos usuários. Também gostaria de configurar uma comunidade Zenodo para Sympy e SymEngine.