Quick Tips

This section of the howto includes short RST snippets covering how to do simple things. It is far from definitive, so make sure you consult the complete rST Reference for more information

Including Images

Images are included using the image directive:

.. image:: <image-path>

Use a Central links file

I’ve found it particularly useful to centralize all of my links in a central links.txt file, such as the one shown below:

.. _Sphinx: http://sphinx.pocoo.org/
.. _Sphinx Documentation: http://sphinx.pocoo.org/contents.html
.. _showing code examples: http://sphinx.pocoo.org/markup/code.html
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _rST Reference: http://docutils.sourceforge.net/rst.html#reference-documentation
.. _directive: http://docutils.sourceforge.net/docs/ref/rst/directives.html
.. _markdown: http://daringfireball.net/projects/markdown/

Once you have this file, you can then include it with a simple include statement and have those links correctly interpreted on any page in your documentation:

=========
Test Page
=========

This test page is about `markdown`_.

.. include:: links.txt