Sử dụng bản thân để tạo một sơ đồ trang web với toctree trong nhân sư có vẻ bị hỏng?

Question

Tôi đang cập nhật Câu hỏi thường gặp cho một dự án khá lớn và tôi muốn thêm chỉ mục các câu hỏi ở đầu trang để người dùng dễ dàng tìm thấy những gì họ đang tìm kiếm hơn.

Tài liệu Sphinx toctree article tiểu bang "Tên mục nhập đặc biệt tự đại diện cho tài liệu chứa chỉ thị toctree. Điều này rất hữu ích nếu bạn muốn tạo" sơ đồ trang web "từ toctree." Đây là những gì tôi muốn. Vấn đề là bản thân dường như bị hỏng và chỉ bao gồm tiêu đề tài liệu hiện tại chứ không phải phụ đề. Nó hoạt động chính xác khi tôi đang ở trong một tài liệu khác và tham khảo các câu hỏi thường gặp, chỉ trong tài liệu chính nó không nó.

Để chứng minh

.. toctree:: 
    :maxdepth: 3 

    faq 

Trong kết quả tập tin khác trong

• câu hỏi thường gặp
  • FAQ
    • Câu hỏi 1
    • Qu estion 2
    • Câu hỏi 3
  • hành vi phi rõ ràng và cần thiết khác để biết

Bên faq

.. toctree:: 
    :maxdepth: 3 

    self 

kết quả trong

• fre Những câu hỏi thường gặp

Tôi đã nghĩ rằng có lẽ đó là vì nhân sư không nhận thức được phụ đề khi toctree được chuyển đổi và cố di chuyển toctree đến cuối trang. Không thay đổi.

Bất kỳ ý tưởng về cách để bao gồm một chỉ số của một trang trong trang riêng của mình với nhân sư sẽ được đánh giá rất

Answer 1

gì bạn đang tìm kiếm là các chỉ thị contents.

Chèn khối sau đây sau khi tiêu đề của trang của bạn để xây dựng danh sách các câu hỏi sau:

.. contents:: 
    :local: 
    :depth: 1 

Nó sẽ tạo ra:

• Câu hỏi 1
• Câu hỏi 2
• Câu hỏi 3