Skip to content

Commit

Permalink
Documentation: fix common substitutions
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
tavip committed Feb 23, 2018
1 parent 3cb002d commit 77def8f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
rst_epilog = """
.. |LXR| replace:: LXR
.. _LXR: http://elixir.free-electrons.com/linux/latest/source


"""
1 change: 0 additions & 1 deletion Documentation/teaching/labs/conf.py

This file was deleted.

0 comments on commit 77def8f

Please sign in to comment.