私はつい最近 (昨日) sphinx の使用を開始し、自分のプロジェクトのドキュメントを読みました。
今のところ Html ドキュメントに満足していますが、pdf バージョンには目次見出し内のインデックスに表示されるすべての記事が含まれています。Documents の元のコンテンツ/インデックスは、単純に 2 つのリンクで構成されています。
助けてください。
ドキュメントはhttp://todx.rtfd.ioにあり、pdf はhere にあります。
私はつい最近 (昨日) sphinx の使用を開始し、自分のプロジェクトのドキュメントを読みました。
今のところ Html ドキュメントに満足していますが、pdf バージョンには目次見出し内のインデックスに表示されるすべての記事が含まれています。Documents の元のコンテンツ/インデックスは、単純に 2 つのリンクで構成されています。
助けてください。
ドキュメントはhttp://todx.rtfd.ioにあり、pdf はhere にあります。
PDF を生成するとき、Sphinx は常に.. toctree::
、ディレクティブが配置されている正確な場所に、ディレクティブを介して参照されるコンテンツを追加します。対照的に、HTML を生成する場合、Sphinx は .xmlファイルを含むファイルの後toctree
にコンテンツを配置します。
この点で、PDF 生成と HTML 生成は単純に矛盾しています。
したがって、目次の前にインデックス ページのすべてのコンテンツを配置する必要があります。
最も重要なセクションの概要をインラインで提供したい場合は、参照のリストを使用できます。次に、たとえば次のようにtoctree
、プロパティを使用して非表示にすることができます。hidden
Contents
--------
- :ref:`quickstart`
- :ref:`userguide`
Features
--------
- Fast
- Simple
- Inituitive
- Easy to Use
- Offline
- Open Source
.. toctree::
:hidden:
quickstart
userguide