sphinxcontrib-taglist

sphinxcontrib-taglist là một Sphinx "taglist" mở rộng.
TagList
Taglist là một phần mở rộng cho hệ thống tài liệu Sphinx.
Cài đặt
Lắp đặt thông qua pip:
pips cài đặt sphinxcontrib-taglist
hoặc thông qua github:
git clone https://github.com/spinus/sphinxcontrib-taglist
cd sphinxcontrib-taglist
python setup.py cài đặt
Tiếp theo, bạn phải thêm phần mở rộng để 'conf.py' trong dự án nhân sư của bạn.
phần mở rộng = [
& Nbsp; ...,
& Nbsp; 'sphinxcontrib.taglist',
& Nbsp; ...]
Cấu hình
Khi sử dụng thẻ với phần mở rộng này, bạn có thể muốn cung cấp cho mỗi thẻ màu khác. Bạn có thể làm điều đó trong 'conf.py' bằng cách thêm vào:
taglist_tags = {
& Nbsp; 'TAG1': {'background-color': 'xanh'}
}
Chỉ thị
tag:
& Nbsp; chỉ tag thêm một "mảnh" của thông tin, và bạn có thể khóa nó.
& Nbsp; Bạn có thể sử dụng nó như:
& Nbsp; .. tag :: Một số thông tin được gắn thẻ
& Nbsp;: tag: TAG1 TAG2 TAG 3
& Nbsp; hoặc:
& Nbsp; .. tag :: [TAG1 TAG2 TAG 3] Một số thông tin được gắn thẻ

& Nbsp; Cảnh báo: Phương pháp thứ hai là chỉ được sử dụng nếu phương pháp đầu tiên không phải là.
& nbsp; Cảnh báo: Tôi không chắc chắn cú pháp này, nó có thể thay đổi. Nếu bạn có gợi ý anny xin vui lòng cho tôi biết.
taglist:
& Nbsp; taglist là một chỉ thị mà bắt thẻ và làm một danh sách.
& Nbsp; Trước hết nó in 'Tags: ... với những thông tin mà nó sẽ hiển thị các thẻ, và hơn nó cho thấy danh sách.
& Nbsp; Bạn có thể sử dụng nó như:
& Nbsp; .. taglist ::
& Nbsp;: tags: TAG1 TAG 3
Làm thế nào nó hoạt động?
Các codebase có nguồn gốc từ sphinxcontrib-yêu cầu làm việc theo cách tương tự.
Trong tài liệu chỉ thị tag đọc tạo tag_node`s. `Taglist tạo các nút taglist.
Trong việc giải quyết các nút taglist được thay đổi thành một đoạn văn bản Tags: với thẻ hạng mục sẽ được hiển thị trên danh sách đó. Tiếp theo nó in tất cả các mặt hàng được gắn thẻ.
CSS
taglist.css:
& Nbsp; Nó chứa lớp cơ sở cho tag - taglist_tag

& Nbsp; Cảnh báo: Nó có lẽ sẽ được thay đổi và đưa vào taglist_tags.css. (Và nó sẽ được cấu hình từ conf.py)
Ngoài ra, nó tạo ra các tập tin taglist_tags.css trong khi chế biến (với css cho mỗi tag bạn định nghĩa trong conf.py; taglist_tags bản đồ tất cả các khóa thẻ để khóa css). Và viết nó để xây dựng thư mục cho các tập tin tĩnh

Yêu cầu :

• Python
• Sphinx