]> git.baikalelectronics.ru Git - kernel.git/commit
Documentation/sphinx: add Sphinx kernel-doc directive extension
authorJani Nikula <jani.nikula@intel.com>
Wed, 18 May 2016 20:30:30 +0000 (23:30 +0300)
committerJani Nikula <jani.nikula@intel.com>
Mon, 30 May 2016 10:38:52 +0000 (13:38 +0300)
commit100c79ff93143868f4e662d5930c66de0c4a2007
treea20918ac6bec418f877d63bc0523d01d7a8781bb
parentbdcaf14a5f501237e33e6954816fa265af2588f5
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>
Documentation/sphinx/kernel-doc.py [new file with mode: 0644]