spatialaudio/nbsphinx

🧠 nbsphinx: Nhúng notebook Jupyter vào tài liệu Sphinx một cách liền mạch

nbsphinx biến notebook Jupyter thành phần tử đầu tiên trong tài liệu Sphinx, không cần xuất khẩu thủ công.

nbsphinx là một phần mở rộng Sphinx cung cấp parser nguồn cho file *.ipynb. Nó sử dụng các directive tùy chỉnh của Sphinx để hiển thị ô code và kết quả trong cả output HTML và LaTeX. Notebook chưa được thực thi sẽ tự động chạy lại trong quá trình build.

✨ Điểm nổi bật

• Hỗ trợ *.ipynb trực tiếp: Dùng như nguồn cho Sphinx mà không cần chuyển đổi.
• Hiển thị code và kết quả: Giữ nguyên cả ô code và output trong tài liệu.
• Tự động thực thi notebook: Nếu notebook chưa có output, nbsphinx sẽ chạy lại trong lúc build.
• Hỗ trợ HTML và LaTeX: Output đồng nhất trên cả hai định dạng.
• Dễ tích hợp: Chỉ cần thêm 'nbsphinx' vào extensions trong conf.py.

💡 Vì sao đáng chú ý

Thay vì phải xuất notebook ra markdown hoặc HTML trước khi dùng Sphinx, nbsphinx cho phép dùng trực tiếp file .ipynb như một nguồn tài liệu hợp lệ. Điều này giữ được tính tương tác và cấu trúc gốc của notebook trong khi vẫn tận dụng hệ thống build mạnh mẽ của Sphinx. Rất hữu ích cho tài liệu hướng dẫn, tutorial kèm code thực thi, hoặc sách điện tử mang tính khoa học.

#Jupyter #Sphinx #Documentation #OpenSource #TiniX