How can I link/reference another reST file in the documentation?

前端 未结 4 971
我寻月下人不归
我寻月下人不归 2021-02-03 16:57

I have simply no idea on how can I link to another document in the reST file.

I want to link a file named install.rst to my quickstart guide in a paragraph.

4条回答
  •  有刺的猬
    2021-02-03 17:23

    Simplifying @eme-eme's answer, you can just do:

    :doc:`path/to/document`
    

    You don't need to enclose the path in <> and provide a text to be displayed. In this case, a top-level header from the referenced document will be displayed as a link.

    You don't need inter-sphinx extension for that.

提交回复
热议问题