From 77def8f3f7ddeaa80b8e0638148f2b0ca3fa7dab Mon Sep 17 00:00:00 2001 From: Octavian Purdila Date: Sat, 24 Feb 2018 00:13:18 +0100 Subject: [PATCH] Documentation: fix common substitutions The conf.py needs to be at the top of the namespace directory so move it where it belongs. And since we now have multiple subdirectories and includes are relative to current file directory, the common substitution will not longer work for all files. To fix this, just move the contents of subst.hrst directly to rst_epilog in conf.py. Fixes the following errors: deferred_work.rst:721: ERROR: Undefined substitution referenced: "LXR". deferred_work.rst:721: ERROR: Unknown target name: "lxr". interrupts.rst:688: ERROR: Undefined substitution referenced: "LXR". interrupts.rst:688: ERROR: Unknown target name: "lxr". kernel_api.rst:739: ERROR: Unexpected indentation. kernel_api.rst:582: ERROR: Undefined substitution referenced: "LXR". kernel_api.rst:582: ERROR: Unknown target name: "lxr". kernel_modules.rst:810: ERROR: Undefined substitution referenced: "LXR". kernel_modules.rst:939: ERROR: Undefined substitution referenced: "LXR". kernel_modules.rst:810: ERROR: Unknown target name: "lxr". kernel_modules.rst:939: ERROR: Unknown target name: "lxr". Signed-off-by: Octavian Purdila --- Documentation/teaching/{labs/subst.hrst => conf.py} | 4 ++-- Documentation/teaching/labs/conf.py | 1 - 2 files changed, 2 insertions(+), 3 deletions(-) rename Documentation/teaching/{labs/subst.hrst => conf.py} (80%) delete mode 100644 Documentation/teaching/labs/conf.py diff --git a/Documentation/teaching/labs/subst.hrst b/Documentation/teaching/conf.py similarity index 80% rename from Documentation/teaching/labs/subst.hrst rename to Documentation/teaching/conf.py index d0f113b1b14cd8..db98921b627e1b 100644 --- a/Documentation/teaching/labs/subst.hrst +++ b/Documentation/teaching/conf.py @@ -1,4 +1,4 @@ +rst_epilog = """ .. |LXR| replace:: LXR .. _LXR: http://elixir.free-electrons.com/linux/latest/source - - +""" diff --git a/Documentation/teaching/labs/conf.py b/Documentation/teaching/labs/conf.py deleted file mode 100644 index 25a53c0b06c15c..00000000000000 --- a/Documentation/teaching/labs/conf.py +++ /dev/null @@ -1 +0,0 @@ -rst_prolog = ".. include:: subst.hrst"