summaryrefslogtreecommitdiff
path: root/Documentation/Makefile.sphinx
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2016-05-18 23:30:30 +0300
committerJani Nikula <jani.nikula@intel.com>2016-05-30 13:38:52 +0300
commitc56de1db54dfbbdfc02a500388952af16e3a9368 (patch)
treea20918ac6bec418f877d63bc0523d01d7a8781bb /Documentation/Makefile.sphinx
parent81cd318102aedee64d3bd38d2e04ea333569abfd (diff)
Documentation/sphinx: add Sphinx kernel-doc directive extension
Add an extension to handle kernel-doc directives, to call kernel-doc according to the arguments and parameters given to the reStructuredText directive. The syntax for the kernel-doc directive is: .. kernel-doc:: FILENAME :export: :internal: :functions: FUNCTION [FUNCTION ...] :doc: SECTION TITLE Of the directive options export, internal, functions, and doc, currently only one option may be given at a time. The FILENAME is relative from the kernel source tree root. The extension notifies Sphinx about the document dependency on FILENAME, causing the document to be rebuilt when the file has been changed. Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Diffstat (limited to 'Documentation/Makefile.sphinx')
0 files changed, 0 insertions, 0 deletions