chiark / gitweb /
doc: improve docs about the include directive.
authorVladimír Vondruš <mosra@centrum.cz>
Thu, 30 Nov 2017 17:47:58 +0000 (18:47 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Thu, 30 Nov 2017 17:50:46 +0000 (18:50 +0100)
doc/plugins/math-and-code.rst

index 63bc65c227ea5ac07e112235b0589c31335d857e..f43f58086a8f6e1fd517d31ecd33d9d8d876d327 100644 (file)
@@ -208,6 +208,13 @@ All options of the :rst:`.. code::` directive are supported as well.
         :code: c++
         :start-line: 2
 
+.. note-info::
+
+    Note that the :rst:`.. include::` directives are processed before Pelican
+    comes into play, and thus no special internal linking capabilities are
+    supported. In particular, relative paths are assumed to be relative to path
+    of the source file.
+
 For inline code highlighting, use :rst:`:code:` interpreted text role. To
 specify which language should be highlighted, derive a custom role from it: