Dự án SymPy

Trang này chứa thông tin chi tiết về một dự án viết nội dung kỹ thuật đã được chấp nhận tham gia Google Season of Docs.

Tóm tắt dự án

Tổ chức nguồn mở:

SymPy

Người viết nội dung kỹ thuật:

Rohit Goswami

Tên dự án:

SymEngine

Thời lượng dự án:

Thời hạn tiêu chuẩn (3 tháng)

Mô tả dự án

Mặc dù tài liệu Sympy có thể truy cập được một cách hợp lý, nhưng tài liệu SymEngine hiện hầu như không truy cập được. Có các nhận xét trong mã nguồn, nhưng bạn cần định dạng lại các nhận xét này để sử dụng hiệu quả hơn với Doxygen. Đề xuất dự án này là hoàn chỉnh và sẽ bao gồm việc thiết lập quy trình CI để tạo trang web kèm theo tài liệu, cũng như các điểm cải tiến đối với tài liệu hiện có (về mức độ phù hợp và ví dụ cấp cao). Việc này cũng bao gồm việc lấy các phần thích hợp từ wiki và các nguồn khác, cũng như thêm hướng dẫn dành cho cộng tác viên. Dự án đề cập đến việc có thể sử dụng Sphinx, nhưng cá nhân tôi không đồng ý với điều đó, vì Doxygen hoạt động rất tốt mà không cần xử lý thêm (ví dụ: https://docs.dseams.info). Tuy nhiên, nếu cần, tôi sẵn sàng thiết lập thêm các giao diện người dùng để sử dụng. Tôi cũng muốn tạo phiên bản PDF của tài liệu. Mục tiêu mở rộng sẽ liên quan đến việc đặt nhiều ví dụ cụ thể về Symengine và cho phép chấp nhận nội dung đóng góp của người dùng. Tôi cũng muốn thiết lập một cộng đồng Zenodo cho cả Sympy và SymEngine.