mirror of
https://github.com/torvalds/linux.git
synced 2026-05-29 01:23:56 +02:00
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:
parent
33220c1fc1
commit
333f602e2f
|
|
@ -12,6 +12,7 @@ more additions are needed here:
|
|||
|
||||
rtla/index
|
||||
rv/index
|
||||
python
|
||||
|
||||
.. only:: subproject and html
|
||||
|
||||
|
|
|
|||
12
Documentation/tools/kdoc.rst
Normal file
12
Documentation/tools/kdoc.rst
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
==================
|
||||
Kernel-doc modules
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
kdoc_parser
|
||||
kdoc_output
|
||||
kdoc_ancillary
|
||||
46
Documentation/tools/kdoc_ancillary.rst
Normal file
46
Documentation/tools/kdoc_ancillary.rst
Normal 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:
|
||||
14
Documentation/tools/kdoc_output.rst
Normal file
14
Documentation/tools/kdoc_output.rst
Normal 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:
|
||||
|
||||
29
Documentation/tools/kdoc_parser.rst
Normal file
29
Documentation/tools/kdoc_parser.rst
Normal 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:
|
||||
10
Documentation/tools/python.rst
Normal file
10
Documentation/tools/python.rst
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
================
|
||||
Python libraries
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
kdoc
|
||||
Loading…
Reference in New Issue
Block a user