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

前端 未结 4 992
我寻月下人不归
我寻月下人不归 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:42

    I write the link to another document using this:

    :doc:`my document <../my_doc>` 
    

    ../my_doc is the path to my my_doc.rst file.

    I also have inter-sphinx extension in my conf.py file.

    extensions = ['sphinx.ext.intersphinx']
    

提交回复
热议问题