SymPy 프로젝트

이 페이지에는 Google 시즌의 Docs에 승인된 기술 글쓰기 프로젝트의 세부정보가 포함되어 있습니다.

프로젝트 요약

오픈소스 조직:
SymPy
기술 문서 작성자:
로힛 고스와미
프로젝트 이름:
SymEngine
프로젝트 길이:
표준 기간 (3개월)

Project description

Sympy 문서는 비교적 쉽게 액세스할 수 있지만 SymEngine 문서는 현재 대부분 액세스할 수 없습니다. 소스 코드에 주석이 있지만 Doxygen에서 더 효과적으로 사용하려면 주석의 형식을 다시 지정해야 합니다. 프로젝트 제안서는 엔드 투 엔드이며 문서가 포함된 웹사이트를 생성하기 위한 CI 파이프라인 설정과 기존 문서 개선 (범위 및 대략적인 예시)을 다룹니다. 여기에는 위키 및 기타 출처에서 적절한 부분을 가져오고 참여자 가이드를 추가하는 것도 포함됩니다. 프로젝트에서 Sphinx를 사용할 수 있다고 언급했지만 저는 개인적으로 이에 반대합니다. Doxygen은 추가 처리 없이도 매우 잘 작동하기 때문입니다 (예: https://docs.dseams.info). 하지만 필요한 경우 소비를 위해 더 많은 프런트엔드를 설정할 수 있습니다. 문서의 PDF 버전도 생성하고 싶습니다. 연장 목표에는 여러 Symengine 관련 예시를 설정하고 사용자 참여를 허용하는 것이 포함됩니다. Sympy와 SymEngine 모두를 위한 Zenodo 커뮤니티도 설정하고 싶습니다.