2010-09-21 6 views
8

Tôi muốn tạo phần "thuật ngữ" với định nghĩa cho các thuật ngữ tôi đang sử dụng sao cho mỗi khi tôi sử dụng các thuật ngữ trong phần thuật ngữ này, một liên kết được tạo ra trỏ đến định nghĩa.Trong Nhân sư, làm cách nào tôi có thể tạo phần "thuật ngữ" có thể liên kết mà không phải trả phí lớn?

Hiện nay, tốt nhất tôi có thể nghĩ ra là:

.. |flavor| replace:: `:ref:flavor` 

.. _flavor: 

flavor 
------ 
blah blah blah 

Rồi sau đó, trong văn bản khác tôi phải làm:

''' This is a usage of the word |flavor|.''' 

tôi thấy cú pháp trên là rất cồng kềnh. Tôi biết tôi có thể sử dụng thêm một lớp kịch bản hay m4 để tự động tạo ra cú pháp này, nhưng tôi hy vọng có một cách tốt hơn ..

Trả lời

20

Không phải như vậy khác nhau, nhưng bạn có thể sử dụng:

.. glossary ::

Chỉ thị này phải chứa danh sách định nghĩa lại với các điều khoản và định nghĩa. Các định nghĩa sau đó sẽ được tham chiếu với vai trò 'thuật ngữ'.

: Thuật ngữ:

Tham chiếu đến một thuật ngữ trong phần chú giải. Bảng thuật ngữ được tạo bằng cách sử dụng chỉ thị bảng chú giải chứa danh sách định nghĩa có các thuật ngữ và định nghĩa. Nó không phải nằm trong cùng một tệp như đánh dấu cụm từ, ví dụ các tài liệu Python có một bảng thuật ngữ toàn cầu trong tệp glossary.rst.

Nếu bạn sử dụng cụm từ không được giải thích trong bảng chú giải thuật ngữ, bạn sẽ nhận được cảnh báo khi xây dựng.

[dán từ official sphinx documentation]

+0

Tôi đoán tôi should'a tham khảo ý kiến ​​từ điển để tìm một từ khác nhau cho "thuật ngữ" khi tìm kiếm các tài liệu sư. Cảm ơn eolo999. –