How to create a link to a header in restructuredtext?

后端 未结 2 1355
说谎
说谎 2021-01-22 10:12

I have a document in restructuredtest like:

Header 1
========

and from some any other point (might be the same \'rst\' file or a different one

相关标签:
2条回答
  • 2021-01-22 10:41

    In addition to the accepted answer, the label you add (in this case .. _header-1-label-name:) is required to have a dash. So a simple .. _label: won't do. Took me a while to figure that out.

    0 讨论(0)
  • 2021-01-22 10:54

    Your first link was almost correct. You need to add a label preceding the section header, separated by a blank line. See Inline markup, Cross-referencing arbitrary locations, using the :ref: directive.

    In your case:

    .. _header-1-label-name:
    
    Header 1
    ========
    
    Some text
    
    Here is a section reference: :ref:`header-1-label-name`.
    
    Here is a section reference with a title: :ref:`Header 1 with a title <header-1-label-name>`.
    
    0 讨论(0)
提交回复
热议问题