Skip to content

Commit 333f602

Browse files
mchehabJonathan Corbet
authored andcommitted
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>
1 parent 33220c1 commit 333f602

6 files changed

Lines changed: 112 additions & 0 deletions

File tree

Documentation/tools/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ more additions are needed here:
1212

1313
rtla/index
1414
rv/index
15+
python
1516

1617
.. only:: subproject and html
1718

Documentation/tools/kdoc.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
==================
4+
Kernel-doc modules
5+
==================
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
kdoc_parser
11+
kdoc_output
12+
kdoc_ancillary
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=================
4+
Ancillary classes
5+
=================
6+
7+
Argparse formatter class
8+
========================
9+
10+
.. automodule:: lib.python.kdoc.enrich_formatter
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
Regular expression class handler
16+
================================
17+
18+
.. automodule:: lib.python.kdoc.kdoc_re
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
24+
Chinese, Japanese and Korean variable fonts handler
25+
===================================================
26+
27+
.. automodule:: lib.python.kdoc.latex_fonts
28+
:members:
29+
:show-inheritance:
30+
:undoc-members:
31+
32+
Kernel C file include logic
33+
===========================
34+
35+
.. automodule:: lib.python.kdoc.parse_data_structs
36+
:members:
37+
:show-inheritance:
38+
:undoc-members:
39+
40+
Python version ancillary methods
41+
================================
42+
43+
.. automodule:: lib.python.kdoc.python_version
44+
:members:
45+
:show-inheritance:
46+
:undoc-members:
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=======================
4+
Kernel-doc output stage
5+
=======================
6+
7+
Output handler for man pages and ReST
8+
=====================================
9+
10+
.. automodule:: lib.python.kdoc.kdoc_output
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=======================
4+
Kernel-doc parser stage
5+
=======================
6+
7+
File handler classes
8+
====================
9+
10+
.. automodule:: lib.python.kdoc.kdoc_files
11+
:members:
12+
:show-inheritance:
13+
:undoc-members:
14+
15+
Parsed item data class
16+
======================
17+
18+
.. automodule:: lib.python.kdoc.kdoc_item
19+
:members:
20+
:show-inheritance:
21+
:undoc-members:
22+
23+
Parser classes and methods
24+
==========================
25+
26+
.. automodule:: lib.python.kdoc.kdoc_parser
27+
:members:
28+
:show-inheritance:
29+
:undoc-members:

Documentation/tools/python.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
================
4+
Python libraries
5+
================
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
kdoc

0 commit comments

Comments
 (0)