2013-02-23 9 views
6

RSTファイルに存在するサブセクションの1つ(またはすべて)をメインのTOCツリーから隠すことはできますか?メインのTOCツリーからスフィンクスサブセクションを隠す

は私はもう少し説明してみましょう:

file.rst 子供/

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

.. toctree:: 

    Label of Grandchildren 1 
    Label of Grandchildren 2 


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

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

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

これらのファイル

: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> 

index.rst、後に構築された、となりますメインTOCツリー内:

  • レーベル
  • レーベル
  • 子供
    • 孫のラベル孫の1枚の
    • ラベル2
    • サブセクション1
    • サブセクション3
  • のレーベル

私は、TOCTreesだけを保持して、私が望むように多くの、そして深く、サブセクションを隠したいと思います。例:孫2

しかし、ハイパーリンクがに関連付けられている場合の孫の子供 の

  • ラベル
  • ラベル
  • ラベル
    • ラベルは1
    • ラベル子供のラベルをクリックすると、サブセクションは通常通り表示されます。

+1

多分、 'titlesonly'オプションはあなたが探しているものです。 http://sphinx-doc.org/markup/toctree.htmlを参照してください。 – mzjn

+0

私はそれを試しましたが、それは私が欲しいものの正反対で、タイトルを保持し、子供のTOCツリーを隠しています。 –

+0

[[再構成されたテキストページ内の非TOC見出し]の可能な重複](http://stackoverflow.com/questions/19069405/non-toc-headings-within-a-restructuredtext-page) – Chris

答えて

3

あなたはTOCがどれだけ深く設定するtoctreemaxdepthパラメータを使用することができます。

.. toctree:: 
    :maxdepth: 2 
2

これはAWH連れて行ってくれました把握することができましたが、ついにそれを得たと思います。 "トリック"は、tocを含む親の最初と、そのセクションを含む子の最初の両方にディレクティブを設定する必要があるということです。

私にとっては、親の最初のtocに:maxdepth:1:titlesonly:を追加し、次に子供のtocに:titlesonly:を追加しました。これは完全に機能します。これにより、TOCに表示されない、適切にレンダリングされた子で階層的なサブセクションの書式設定ができるようになります。

+0

*ちょうど*必要なもの。私は実際には 'index.rst'のtoctreeに':maxdepth:2'を書いていますが、 ':titlesonly:'でも子ページで定義したサブセクションを抑制するのにうまくいきました。 – hBy2Py

1

サブセクション1などで****************に変更してみてください。また、あなた

.. 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> 
関連する問題