2014-06-09 19 views
22

Làm cách nào để đưa một bảng nội dung cục bộ vào tài liệu Sphinx?Làm cách nào để đưa một bảng nội dung địa phương vào tài liệu Sphinx?

tôi đã cố gắng

.. toc:: 

Nhưng điều đó dường như không có bất kỳ tác dụng: không có gì được chèn trong tài liệu.

Về cơ bản, tôi cần liên kết đến các phần trong trang hiện tại để được đặt tại một vị trí nhất định của mỗi trang.

Điều này có khả thi không?

Trả lời

24

Tôi không chắc chắn 100% đây là những gì bạn đang tìm kiếm, nhưng chỉ thị .. contents:: có thể hữu ích. Theo mặc định, nó sẽ cung cấp cho bạn các tiêu đề cho toàn bộ trang, bất cứ nơi nào bạn đưa chỉ thị. Với :local: được chỉ định, nó sẽ tạo một TOC cục bộ cho các tiêu đề bên dưới, nơi bạn đặt chỉ thị (tiện dụng cho các phần phụ).

Thêm chi tiết tại đây: http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

+3

nội dung '.. ::: local:' là nước ma thuật. Khi bỏ qua cờ ': local:', mục lục được thêm vào vô hạn bởi một liên kết đến tiêu đề tài liệu. Hơn nữa, tất cả các tiêu đề khác là các phân nhóm của tiêu đề tài liệu và do đó vô dụng thụt vào một cấp độ sâu hơn so với chúng. Tóm lại, ': local:' là tất cả nhưng bắt buộc đối với hầu hết các trường hợp sử dụng. (_Tôi thực sự muốn ': local:' là mặc định, thẳng thắn ._) –

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