Introduce kernel-doc API support

kernel-doc API support is introduced by linuxdoc package that includes Linux kernel tools used to generate the documentation. With this patch we fully support the kernel documentation format that can be found here: https://return42.github.io/linuxdoc/linuxdoc-howto/kernel-doc-syntax.html
acerv · Mar 20, 2024 · 826fc86 · 826fc86
1 parent 15dc0f3
commit 826fc86
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 2 deletions.
diff --git a/doc_new/conf.py b/doc_new/conf.py
@@ -14,8 +14,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
-
+extensions = ['linuxdoc.rstKernelDoc']
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

diff --git a/doc_new/developers/api_c_tests.rst b/doc_new/developers/api_c_tests.rst
@@ -1,4 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0-or-later
 
+.. Include headers in this file with:
+.. .. kernel-doc:: ../../include/tst_test.h
+
 Developing using C API
 ======================
diff --git a/doc_new/developers/api_kvm_tests.rst b/doc_new/developers/api_kvm_tests.rst
@@ -1,4 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0-or-later
 
+.. Include headers in this file with:
+.. .. kernel-doc:: ../../include/tst_test.h
+
 Developing using KVM API
 ========================
diff --git a/doc_new/developers/api_network_tests.rst b/doc_new/developers/api_network_tests.rst
@@ -1,4 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0-or-later
 
+.. Include headers in this file with:
+.. .. kernel-doc:: ../../include/tst_test.h
+
 Developing using network API
 ============================
diff --git a/doc_new/requirements.txt b/doc_new/requirements.txt
@@ -1 +1,2 @@
 sphinx-rtd-theme==2.0.0
+linuxdoc==20231020