如何设置自定义headerlink?

时间:2014-05-08 00:56:04

标签: python-sphinx

如何在sphinx中自定义headerlink?

.. page.html

page
====

My header
______

My header决定关联http://example.com/page.html#my-header

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

1 个答案:

答案 0 :(得分:3)

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

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,您可以拥有更多控制权,包括控制headerlink,但是你会丢失它在toc中的呈现。

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