diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2020-06-18 18:51:31 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2020-06-18 18:51:31 +0200 |
| commit | aa5f947157869f9d53eacd820cc9e5400c95132c (patch) | |
| tree | e57645b0f98afde8d89c4e7d801bbb67fdd0ac28 /docs | |
| parent | 15924bcb67680933f6ef71ddc3cd910fed62fbbd (diff) | |
| download | searxng-aa5f947157869f9d53eacd820cc9e5400c95132c.tar.gz searxng-aa5f947157869f9d53eacd820cc9e5400c95132c.zip | |
[enh] add 'kernel-include' reST-directive
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/dev/reST.rst | 5 |
2 files changed, 4 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 9e6d32931..1f79e4c14 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -66,6 +66,7 @@ extensions = [ "sphinx_issues", # https://github.com/sloria/sphinx-issues/blob/master/README.rst "sphinxcontrib.jinja", # https://github.com/tardyp/sphinx-jinja "sphinxcontrib.programoutput", # https://github.com/NextThought/sphinxcontrib-programoutput + 'linuxdoc.kernel_include', # Implementation of the 'kernel-include' reST-directive. 'linuxdoc.rstFlatTable', # Implementation of the 'flat-table' reST-directive. 'linuxdoc.kfigure', # Sphinx extension which implements scalable image handling. "sphinx_tabs.tabs", # https://github.com/djungelorm/sphinx-tabs diff --git a/docs/dev/reST.rst b/docs/dev/reST.rst index 7b253d9ec..906a0e9af 100644 --- a/docs/dev/reST.rst +++ b/docs/dev/reST.rst @@ -325,8 +325,9 @@ Literal blocks The simplest form of :duref:`literal-blocks` is a indented block introduced by two colons (``::``). For highlighting use :dudir:`highlight` or :ref:`reST -code` directive. To include literals from external files use directive -:rst:dir:`literalinclude`. +code` directive. To include literals from external files use +:rst:dir:`literalinclude` or :ref:`kernel-include <kernel-include-directive>` +directive (latter one expands environment variables in the path name). .. _reST literal: |