README.rst: mention the intersphinx directives

NelleV · Jan 26, 2013 · 24d9ead · 24d9ead
1 parent 85d80c6
commit 24d9ead
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -96,6 +96,11 @@ In restructured-text markup this is::
     when using *object-oriented programming* in Python you **must** use the
     ``class`` keyword to define your *classes*.
 
+For cross-referencing API documentation we prefer to use the `intersphinx
+extension <http://sphinx-doc.org/latest/ext/intersphinx.html>`_. This provides
+the directives `:mod:`, `:class:` and `:func:` to cross-link to modules,
+classes and functions respectively.
+
 Modifying
 .........