From: Andrea Cervesato <andrea.cervesato@suse.de>
To: ltp@lists.linux.it
Subject: [LTP] [PATCH v1] doc: Add section for C API documentation
Date: Mon, 15 Apr 2024 11:18:06 +0200 [thread overview]
Message-ID: <20240415091806.18556-1-andrea.cervesato@suse.de> (raw)
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
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next reply other threads:[~2024-04-15 9:18 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-15 9:18 Andrea Cervesato [this message]
2024-04-16 12:53 ` [LTP] [PATCH v1] doc: Add section for C API documentation Cyril Hrubis
2024-04-17 9:19 ` Petr Vorel
2024-04-17 9:20 ` Andrea Cervesato via ltp
2024-04-17 10:07 ` Petr Vorel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240415091806.18556-1-andrea.cervesato@suse.de \
--to=andrea.cervesato@suse.de \
--cc=ltp@lists.linux.it \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).