on master help sign in
[enh] add 'kernel-include' reST-directive

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>

commitaa5f947157869f9d53eacd820cc9e5400c95132c authorMarkus Heiser <markus.heiser@darmarit.de> dateThu 18 Jun 2020, 18:51 (6 years ago) parent15924bc
2 files changed+4−2
docs/conf.py+1 docs/dev/reST.rst+3−2
docs/conf.py+1
@@ -66,6 +66,7 @@ extensions = [
6666 "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst
6767 "sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja
6868 "sphinxcontrib.programoutput", # https://github.com/NextThought/sphinxcontrib-programoutput
69+ 'linuxdoc.kernel_include', # Implementation of the 'kernel-include' reST-directive.
6970 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive.
7071 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling.
7172 "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs
docs/dev/reST.rst+3−2
@@ -325,8 +325,9 @@ Literal blocks
325325
326326The simplest form of :duref:`literal-blocks` is a indented block introduced by
327327two colons (``::``). For highlighting use :dudir:`highlight` or :ref:`reST
328−code` directive. To include literals from external files use directive
329−:rst:dir:`literalinclude`.
328+code` directive. To include literals from external files use
329+:rst:dir:`literalinclude` or :ref:`kernel-include <kernel-include-directive>`
330+directive (latter one expands environment variables in the path name).
330331
331332.. _reST literal:
332333