docs: add kernel-doc modules documentation

Place kernel-doc modules documentation at Linux Kernel docs.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <88ac2d82a45718c4e27aefac831586a71204ebf2.1768838938.git.mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2026-01-19 17:23:18 +01:00 committed by Jonathan Corbet
parent 33220c1fc1
commit 333f602e2f
6 changed files with 112 additions and 0 deletions

View File

@ -12,6 +12,7 @@ more additions are needed here:
rtla/index
rv/index
python
.. only:: subproject and html

View File

@ -0,0 +1,12 @@
.. SPDX-License-Identifier: GPL-2.0
==================
Kernel-doc modules
==================
.. toctree::
:maxdepth: 2
kdoc_parser
kdoc_output
kdoc_ancillary

View File

@ -0,0 +1,46 @@
.. SPDX-License-Identifier: GPL-2.0
=================
Ancillary classes
=================
Argparse formatter class
========================
.. automodule:: lib.python.kdoc.enrich_formatter
:members:
:show-inheritance:
:undoc-members:
Regular expression class handler
================================
.. automodule:: lib.python.kdoc.kdoc_re
:members:
:show-inheritance:
:undoc-members:
Chinese, Japanese and Korean variable fonts handler
===================================================
.. automodule:: lib.python.kdoc.latex_fonts
:members:
:show-inheritance:
:undoc-members:
Kernel C file include logic
===========================
.. automodule:: lib.python.kdoc.parse_data_structs
:members:
:show-inheritance:
:undoc-members:
Python version ancillary methods
================================
.. automodule:: lib.python.kdoc.python_version
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,14 @@
.. SPDX-License-Identifier: GPL-2.0
=======================
Kernel-doc output stage
=======================
Output handler for man pages and ReST
=====================================
.. automodule:: lib.python.kdoc.kdoc_output
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,29 @@
.. SPDX-License-Identifier: GPL-2.0
=======================
Kernel-doc parser stage
=======================
File handler classes
====================
.. automodule:: lib.python.kdoc.kdoc_files
:members:
:show-inheritance:
:undoc-members:
Parsed item data class
======================
.. automodule:: lib.python.kdoc.kdoc_item
:members:
:show-inheritance:
:undoc-members:
Parser classes and methods
==========================
.. automodule:: lib.python.kdoc.kdoc_parser
:members:
:show-inheritance:
:undoc-members:

View File

@ -0,0 +1,10 @@
.. SPDX-License-Identifier: GPL-2.0
================
Python libraries
================
.. toctree::
:maxdepth: 4
kdoc