]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/commit - Documentation/conf.py
Documentation/sphinx: configure the kernel-doc extension
authorJani Nikula <jani.nikula@intel.com>
Fri, 20 May 2016 08:51:47 +0000 (11:51 +0300)
committerJani Nikula <jani.nikula@intel.com>
Mon, 30 May 2016 10:38:52 +0000 (13:38 +0300)
commit24dcdeb28b55afafa9cdf6acedd78cf1aa8f8428
treea7152965a7b66c036032ee6975e1b20b480a407a
parentc56de1db54dfbbdfc02a500388952af16e3a9368
Documentation/sphinx: configure the kernel-doc extension

Tell Sphinx where to find the extension, and pass on the kernel src tree
and kernel-doc paths to the extension.

With this, any .rst files under Documentation may contain the kernel-doc
rst directive to include kernel-doc documentation from any source file.

While building, it may be handy to pass kernel-doc extension
configuration on the command line. For example, 'make SPHINXOPTS="-D
kerneldoc_verbosity=0" htmldocs' silences all stderr output from
kernel-doc when the kernel-doc exit code is 0. (The stderr will be
logged unconditionally when the exit code is non-zero.)

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Documentation/Makefile.sphinx
Documentation/conf.py