[LTP] [PATCH v1] doc: Add section for C API documentation

Andrea Cervesato andrea.cervesato@suse.de
Mon Apr 15 11:18:06 CEST 2024


From: Andrea Cervesato <andrea.cervesato@suse.com>

Added information about the C API documentation format and the way
it's supported in Sphinx.

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
 doc/developers/documentation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst
index 5b112bcaf..30dacd384 100644
--- a/doc/developers/documentation.rst
+++ b/doc/developers/documentation.rst
@@ -47,3 +47,11 @@ To check documentation words spelling, we provide support for
 documentation can be tested via ``make spelling`` command. Output will be
 visible in the ``doc/build`` folder and, if any error will be found, a warning
 message will be shown.
+
+C API documentation
+~~~~~~~~~~~~~~~~~~~
+
+The C API documentation is written using
+`kernel-doc <https://return42.github.io/linuxdoc/linuxdoc-howto/kernel-doc-syntax.html>`_
+syntax which is supported by Sphinx via
+`linuxdoc <https://pypi.org/project/linuxdoc/>`_ extension.
-- 
2.35.3



More information about the ltp mailing list