Проект SymPy
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- СимПи
- Технический писатель:
- Рохит Госвами
- Название проекта:
- SymEngine
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
Хотя документация Sympy достаточно доступна, документация SymEngine в настоящее время по большей части недоступна. В исходном коде есть комментарии, но их необходимо переформатировать для лучшего использования с Doxygen. Проектное предложение является комплексным и будет охватывать создание конвейера CI для создания веб-сайта с документацией, а также улучшения существующих документов (с точки зрения охвата и примеров высокого уровня). Это также включает в себя использование соответствующих фрагментов из вики и других источников, а также добавление руководства для участников. В проекте упоминается возможность использования Sphinx, но лично я против этого, поскольку Doxygen прекрасно справляется без дальнейшей обработки (например, https://docs.dseams.info). Однако при необходимости я готов настроить больше внешних интерфейсов для потребления. Я также хотел бы создать PDF-версию документации. Расширенные цели будут включать в себя создание нескольких конкретных примеров Symengine и разрешение принятия вкладов пользователей. Я также хотел бы создать сообщество Zenodo для Sympy и SymEngine.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0". Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 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"]]
