Projekt SymPy
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Ta strona zawiera szczegółowe informacje o projekcie polegającym na pisaniu tekstów technicznych, który został zaakceptowany w ramach Google Season of Docs.
Podsumowanie projektu
- Organizacja open source:
- SymPy
- Pisarz techniczny:
- Rohit Goswami
- Nazwa projektu:
- SymEngine
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Chociaż dokumentacja Sympy jest dość łatwo dostępna, dokumentacja SymEngine jest obecnie w większości niedostępna. W kodzie źródłowym są komentarze, ale trzeba je ponownie sformatować, aby można było ich używać w Doxygen. Proponowany projekt jest kompleksowy i obejmie skonfigurowanie potoku CI do generowania witryny z dokumentacją, a także ulepszenia istniejących dokumentów (w zakresie pokrycia i przykładów ogólnych). Obejmuje to również przeniesienie odpowiednich fragmentów z wiki i innych źródeł oraz dodanie przewodnika dla współtwórców. W projekcie wspomina się o możliwości użycia Sphinxa, ale osobiście jestem temu przeciwny, ponieważ Doxygen bardzo dobrze radzi sobie bez dalszej obróbki (np. https://docs.dseams.info). Jeśli to konieczne, mogę jednak skonfigurować więcej interfejsów. Chcę też wygenerować wersję PDF tej dokumentacji. Cele dodatkowe będą obejmować ustawienie wielu przykładów dotyczących Symengine i zezwalanie na akceptację wkładów użytkowników. Chcę też skonfigurować społeczność Zenodo dla Sympy i SymEngine.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2025-07-25 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 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"]]
