sphinx-contrib/matlabdomain

🧮 Tự động sinh tài liệu MATLAB với Sphinx

Extension Sphinx hỗ trợ domain MATLAB, tự động trích xuất help text và sinh tài liệu như HTML từ mã nguồn.

sphinxcontrib-matlabdomain cung cấp một domain cho Sphinx nhằm tự động sinh tài liệu từ các tệp mã nguồn MATLAB. Dự án mô hình hóa sau công cụ autodoc của Python, cho phép tích hợp tài liệu và mã nguồn cùng với Sphinx. Tất cả văn bản trợ giúp trong tệp MATLAB đều có thể được đưa tự động vào tài liệu và xuất ra định dạng như HTML.

✨ Điểm nổi bật

• Cài đặt nhanh: Cài qua pip install sphinxcontrib-matlabdomain, yêu cầu Python >= 3.10 và Sphinx >= 7.0.0.
• Cấu hình linh hoạt: Thêm sphinxcontrib.matlab vào danh sách extensions trong conf.py.
• Hỗ trợ đường dẫn nguồn: Cấu hình matlab_src_dir để chỉ định thư mục chứa mã nguồn MATLAB.
• Tùy chỉnh liên kết ngắn: matlab_short_links rút gọn tên lớp, hàm về dạng ngắn gọn.
• Tự động liên kết thực thể: matlab_auto_link chuyển đổi tên thực thể đã biết thành liên kết.
• Hiển thị thuộc tính mặc định: matlab_show_property_default_value bật/tắt giá trị mặc định của thuộc tính.
• Hiển thị thông số thuộc tính: matlab_show_property_specs hiện thị kích thước, lớp và bộ xác thực.
• Hỗ trợ chữ ký lớp: matlab_class_signature hiển thị danh sách đối số hàm tạo trong chữ ký lớp.

💡 Vì sao đáng chú ý

sphinxcontrib-matlabdomain khác biệt vì làm được điều mà MATLAB không hỗ trợ sẵn: tích hợp sâu với Sphinx để sinh tài liệu tự động từ mã nguồn. Đặc biệt hữu ích cho các dự án lớn sử dụng MATLAB cần quản lý và truyền bá tài liệu kỹ thuật chuyên sâu. Gần giống với cách Python dùng autodoc, nhưng áp dụng cho MATLAB — nơi công cụ tương tự thường thiếu.

---

#MATLAB #Sphinx #Documentation #OpenSource #TiniX