Trả lời

1

Tôi tin rằng bạn đang tìm kiếm Sphinx' JavaScript Domain tính năng.

Chỉnh sửa: Từ việc xem nhanh tài liệu &, có vẻ như bạn không thể sử dụng ReST bên trong JavaScript của mình. Bạn sẽ phải tìm ra tài liệu từ các bình luận, hoặc giữ nó trong các tập tin bên lề.

+0

tôi đã thấy tính năng miền này, nhưng không chắc chắn làm thế nào để bắt đầu với cái đó. –

+0

Thats tốt, tôi không muốn sử dụng ReST bên trong thư viện JavaScript của tôi, nó sẽ là tốt nếu tất cả các thành viên thư viện được tự động phát hiện cùng với các ý kiến ​​liên quan của nhân sư. –

+0

Tôi không theo kịp; »Tự động phát hiện thư viện« thành viên và »bình luận liên quan bởi nhân sư«? AFAIK, Nhân sư không biết cách đọc mã JavaScript, do đó, nó không thể phân tích cú pháp các chức năng hoặc tài liệu liên quan của họ cho bạn. Đó là lý do tại sao tôi đề nghị sử dụng các tập tin sidecar. –

0

Xin lỗi vì phản hồi quá muộn)

Giống như bạn tôi muốn xây dựng tài liệu cho khung JS của riêng mình dựa trên AngularJS.

Và cũng giống như oliverseal, tôi đang xây dựng mở rộng Sphinx theo cách tự nhiên cho Sphinx và ext.autodoc sphinxcontrib-autoanysrc

Nó đơn giản và sạch sẽ, nhưng không có tính năng ext.autodoc cho chữ ký thế hệ tự động và những người khác, nhưng nó đủ đối với tôi lưu trữ còn lại tài liệu của API khuôn khổ trong các tập tin js)

Bạn có thể thực hiện các tính năng ext.autodoc với phần mở rộng sphinxcontrib-autoanysrc kiểm tra autoanysrc.JSAnalyzer

Các vấn đề liên quan