python-sphinx - 如何设置自定义标题链接？

Question

如何在 sphinx 中自定义标题链接？

.. page.html

page
====

My header
______

My header 解析为链接 http://example.com/page.html#my-header

如何获取http://example.com/page.html#my-custom-headerlink？

Answer 1

您可以引用以下格式的链接:

page
====

`My Header <http://example.com/page.html#my-custom-headerlink>`_
----------------------------------------------------------------

或

`My Header <page.html#my-custom-headerlink>`_
----------------------------------------------------------------

您也可以像这样引用它:

`my-header`_
--------------

.. _my-header: http://example.com/page.html#my-custom-headerlink

使用原始 html，您可以拥有更多控制权，包括对标题链接的控制权，但是您会失去它在目录中的呈现。

.. raw:: html

    <div class="section" id="my-custom-headerlink">
    <h2><a class="reference external" href="index.html#my-custom-headerlink">My Header</a>
    <a class="headerlink" href="#my-custom-headerlink" title="Permalink to this headline">¶</a></h2>
    </div>