summaryrefslogtreecommitdiff
path: root/doc/markup/inline.rst
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2009-02-24 13:38:15 +0100
committerGeorg Brandl <georg@python.org>2009-02-24 13:38:15 +0100
commitf8465010e73c3a2add6d9c7a668f0e24eea9cc8d (patch)
tree737f4a288eaaf69898c3139fdb0c79499c4bf910 /doc/markup/inline.rst
parent830aa8ebd393e719c65aa2ef08c14da8e46f44e0 (diff)
downloadsphinx-f8465010e73c3a2add6d9c7a668f0e24eea9cc8d.tar.gz
Paths to literal include files and download files can now be absolute too.
Diffstat (limited to 'doc/markup/inline.rst')
-rw-r--r--doc/markup/inline.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/markup/inline.rst b/doc/markup/inline.rst
index 9f8a01a5..97b20da7 100644
--- a/doc/markup/inline.rst
+++ b/doc/markup/inline.rst
@@ -264,9 +264,12 @@ Referencing downloadable files
See :download:`this example script <../example.py>`.
- The given filename is relative to the directory the current source file is
- contained in. The ``../example.py`` file will be copied to the output
- directory, and a suitable link generated to it.
+ The given filename is usually relative to the directory the current source
+ file is contained in, but if it absolute (starting with ``/``), it is taken
+ as relative to the top source directory.
+
+ The ``example.py`` file will be copied to the output directory, and a
+ suitable link generated to it.
Other semantic markup