python-sphinx - スフィンクス toctree のページ セクションにリンクするにはどうすればよいですか

Question

パッケージ内.. toctreeの他のファイルへの相対リンクを含む sphinx ページの一部として があります。rstページ全体ではなく、特定のページのサブセクションへのリンクを含めるにはどうすればよいですか?

突き刺した

.. toctree::

   page#section

しかし、それはうまくいきませんでした。どんな助けも素晴らしいです。

Answer 1

ToC を作成するとき、Sphinx は構成されたツリー深度内の参照ファイルのすべての見出しと小見出しを含めます。そのため、見出しでページを開始せず、ToC が指すポイントに見出しを挿入することはできません。たとえば、次のようになります。

.. _my-rst-file:
**You can use bold print here if you want. This will not appear in the ToC**
.. rubric:: Or the "rubric" directive

And here some more text, normal font weight.

Here comes the heading that will appear in the ToC
""""""""""""""""""""""""""""""""""""""""""""""""""
And so on...

通常どおり、ToC にページ参照を含める必要があります。したがって、目次には次のものがあります。

.. toctree::

   my_rst_file

この例では、ビルド結果 (HTML、PDF など) はHere comes the heading that will appear in the ToCToC でのみ参照されます。