2013-02-23 28 views
6

Có thể ẩn một (hoặc tất cả) các phần phụ có trong tệp RST từ TOCTree chính không?Ẩn phần phụ Nhân sư khỏi TOCTree chính

Hãy để tôi diễn tả nhiều hơn một chút:

index.rst

:doc:`Label <path/to/rst/file>` 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 

.. toctree:: 

    Label <path/to/rst/file> 
    Label <path/to/rst/file> 

    Label of Children TOCTree <path/to/rst/children/file> 

trẻ em/file.rst

Children Title 
============== 

.. toctree:: 

    Label of Grandchildren 1 
    Label of Grandchildren 2 


Subsection 1 
------------ 

Subsection 2 
------------ 

Subsection 3 
------------ 

Những tập tin này, sau khi được xây dựng, sẽ cho kết quả, trong TOCTree chính:

  • Label
  • Label
  • Label trẻ em
    • Label của Cháu 1
    • Label của Cháu 2
    • Tiểu mục 1
    • Tiểu mục 2
    • Tiểu mục 3

Và tôi muốn ẩn Phần phụ, chỉ giữ TOCTrees, bao nhiêu và sâu như tôi muốn. Ví dụ:

  • Label
  • Label
  • Label trẻ em
    • Label của Cháu 1
    • Label của Cháu 2

Nhưng, nếu các siêu liên kết liên quan đến Nhãn của trẻ em được nhấp, Các phần phụ được liệt kê như bình thường;

+1

Có thể tùy chọn 'titleonly' là thứ bạn đang tìm kiếm. Xem http://sphinx-doc.org/markup/toctree.html. – mzjn

+0

Tôi đã thử nó nhưng nó hoàn toàn trái ngược với những gì tôi muốn, giữ các tựa đề và ẩn TOCTrees của trẻ em. –

+0

có thể trùng lặp của [các tiêu đề không TOC trong một trang Cấu trúc lại] (http://stackoverflow.com/questions/19069405/non-toc-headings-within-a-restructuredtext-page) – Chris

Trả lời

3

Bạn có thể sử dụng các tham số của maxdepthtoctree để thiết lập sâu như thế nào TOC là:

.. toctree:: 
    :maxdepth: 2 
2

này đưa tôi AWH ile để tìm ra, nhưng tôi nghĩ rằng cuối cùng tôi đã nhận nó. Các "lừa" là bạn cần phải thiết lập chỉ thị trong cả hai rst cha mẹ trong đó có các toc và rst con có chứa phần.

Đối với tôi, tôi đã thêm :maxdepth:1:titlesonly: vào toc trong rst gốc và sau đó :titlesonly: cho toc ở trẻ em và hoạt động hoàn hảo.Điều đó cho phép tôi có định dạng phụ phân cấp ở trẻ được hiển thị đúng cách không hiển thị trong TOC.

+0

* Chỉ cần * những gì tôi cần. Tôi thực sự đặc biệt muốn ': maxdepth: 2' trong' index.rst' toctree của tôi, nhưng thậm chí vẫn là ': titleonly:' đã làm việc tốt để ngăn chặn các phần con mà tôi đã định nghĩa trong các trang con. – hBy2Py

1

Hãy thử thay đổi ------------------ thành ***************** cho phần phụ 1 v.v. Ngoài ra, bạn có thể làm cho nhiều toctrees đều có maxdepth riêng, ví dụ:

.. toctree:: 
    :maxdepth: 2 

    Label <path/to/rst/file> 
    Label <path/to/rst/file> 

.. toctree:: 
    :maxdepth: 1 
    Label of Children TOCTree <path/to/rst/children/file> 
Các vấn đề liên quan