Search code examples
python-sphinxrestructuredtextread-the-docs

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

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. I don't know how can I achieve this.

Please can you also refer to a great resource from where I can look up syntax for rest. The default quickstart is a little boring and not involves great depth discussion of using rest with sphinx.

The doc in question is : http://todx.rtfd.io

Solution

  • To referecnce other files I had to include the following in the conf.py. I took the code from the docs of Pillow(PIL fork) here.

    extensions = ['sphinx.ext.intersphinx']

    I think the inter-sphinx extension came to my help. It linked across the other doc pages.