From 1be4d4af1bf08e8c02af4019a8de81f8e5111c1f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 30 Nov 2017 18:47:58 +0100 Subject: [PATCH] doc: improve docs about the include directive. --- doc/plugins/math-and-code.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/plugins/math-and-code.rst b/doc/plugins/math-and-code.rst index 63bc65c2..f43f5808 100644 --- a/doc/plugins/math-and-code.rst +++ b/doc/plugins/math-and-code.rst @@ -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: -- 2.30.2