diff mbox series

[10/10] Introduce kernel-doc API support

Message ID 20240320-new_website-v1-10-79b603c8aea1@suse.com
State Superseded
Headers show
Series New LTP documentation | expand

Commit Message

Andrea Cervesato March 20, 2024, 4:20 p.m. UTC 
From: Andrea Cervesato <andrea.cervesato@suse.com>

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
---
 doc_new/conf.py                          | 3 +--
 doc_new/developers/api_c_tests.rst       | 3 +++
 doc_new/developers/api_kvm_tests.rst     | 3 +++
 doc_new/developers/api_network_tests.rst | 3 +++
 doc_new/requirements.txt                 | 1 +
 5 files changed, 11 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc_new/conf.py b/doc_new/conf.py
index b333ebf2a..44122b761 100644
--- a/doc_new/conf.py
+++ b/doc_new/conf.py
@@ -14,8 +14,7 @@  release = '1.0'
 # -- 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
index c03f9caf1..adee17f16 100644
--- 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
index 1ef7ec452..5ec3fc3a4 100644
--- 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
index 4fe45f5f6..3e487d7f2 100644
--- 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
index 59709ec72..720e6870e 100644
--- a/doc_new/requirements.txt
+++ b/doc_new/requirements.txt
@@ -1 +1,2 @@ 
 sphinx-rtd-theme==2.0.0
+linuxdoc==20231020