From 24d9eade98c42c000d226157640aa18199c1ff8d Mon Sep 17 00:00:00 2001 From: Valentin Haenel Date: Sat, 26 Jan 2013 14:08:06 +0100 Subject: [PATCH] README.rst: mention the intersphinx directives --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index f7ab30732..2c725f6ba 100644 --- 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 `_. This provides +the directives `:mod:`, `:class:` and `:func:` to cross-link to modules, +classes and functions respectively. + Modifying .........