linux/Documentation/doc-guide
Mike Rapoport f2e8603604 Documentation/sphinx: allow "functions" with no parameters
When kernel-doc:: specified in .rst document without explicit directives,
it outputs both comment and DOC: sections. If a DOC: section was explicitly
included in the same document it will be duplicated. For example, the
output generated for Documentation/core-api/idr.rst [1] has "IDA
description" in the "IDA usage" section and in the middle of the API
reference.

This patch enables using "functions" directive without parameters to output
all the documentation excluding DOC: sections.

[1] https://www.kernel.org/doc/html/v4.17/core-api/idr.html

Signed-off-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Acked-by: Matthew Wilcox <willy@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2018-06-30 07:52:42 -06:00
..
conf.py docs-rst: doc-guide: split the kernel-documentation.rst contents 2016-11-19 10:22:04 -07:00
hello.dot docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
index.rst docs: update old references for DocBook from the documentation 2017-05-16 08:44:19 -03:00
kernel-doc.rst Documentation/sphinx: allow "functions" with no parameters 2018-06-30 07:52:42 -06:00
parse-headers.rst doc:sphinx: fix parse-header description 2018-06-26 09:07:57 -06:00
sphinx.rst doc:doc-guide: fix a typo and an error 2018-06-26 09:07:25 -06:00
svg_image.svg docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00