sphinxcontrib-coffee

sphinxcontrib-cà phê là một phần mở rộng Sphinx có thêm một miền CoffeeScript với sự hỗ trợ autodoc để Sphinx.
Điều này dựa trên coffeedoc_ để trích xuất ý kiến ​​nguồn từ `` file .coffee``. Để cài đặt coffeedoc toàn cầu ::
& Nbsp; NPM cài đặt coffeedoc -g
.. _coffeedoc: Https://github.com/omarkhan/coffeedoc
Cách sử dụng
Trước tiên, bạn phải thêm phần mở rộng vào danh sách các phần mở rộng trong conf.py:
& Nbsp; phần mở rộng = ['sphinx.ext.autodoc', 'sphinxcontrib.coffeedomain']
Bởi vì Python không có đầu mối về nơi nguồn của bạn, bạn phải cho nó ở đâu trong conf.py bạn như vậy:
& Nbsp; coffee_src_dir = os.path.abspath ('../')
Cuối cùng, nếu dự án của bạn chủ yếu là CoffeeScript, bạn có thể muốn xác định các tên miền chính cũng như:
& Nbsp; primary_domain = 'cà phê'
Chỉ thị và Vai trò
Tên miền này cung cấp mô-đun, chức năng, lớp học và phương pháp chỉ thị, cũng như meth, đẳng cấp, và vai trò func cho cross-tham khảo. Để tham khảo đối tượng khác, sử dụng nó là tên đầy đủ: Tên module, một dấu hai chấm đôi, và dấu chấm con đường riêng biệt để các đối tượng trong mô-đun.
Ví dụ, để tham khảo các `` chức năng swizzle`` trong tập tin `` lib / widgets.coffee``, viết ``: cà phê: func: `lib / widgets :: swizzle``. Bạn có thể thả hàng đầu ``: coffee`` nếu tên miền chính của bạn đã được thiết lập để cà phê, và bạn có thể thả vào tên module iff bạn đang liên kết từ bên trong các `` lib / module widgets``.
Autodoc
Bạn có thể tài liệu toàn bộ các module một cách dễ dàng với `` automodule``:
.. :: Sourcecode tiên
& Nbsp; .. :: Automodule mymodule
& Nbsp; & nbsp; & nbsp; : Thành viên:

Yêu cầu :

• Python