From 6a4931a7fe00c3987691a7a8c0b22a9bb96f432b Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 19 Jan 2026 17:23:07 +0100 Subject: [PATCH] docs: enable Sphinx autodoc extension to allow documenting python Adding python documentation is simple with Sphinx: all we need is to include the ext.autodoc extension and add the directories where the Python code sits at the sys.path. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: <29cbe375dc418d6fa5793f55199799b5b52dcd38.1768838938.git.mchehab+huawei@kernel.org> --- Documentation/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Documentation/conf.py b/Documentation/conf.py index f0367c48adc6..8e786fe6007f 100644 --- a/Documentation/conf.py +++ b/Documentation/conf.py @@ -19,6 +19,10 @@ kern_doc_dir = os.path.dirname(os.path.abspath(__file__)) # Add location of Sphinx extensions sys.path.insert(0, os.path.join(kern_doc_dir, "sphinx")) +# Allow sphinx.ext.autodoc to document files at tools and scripts +sys.path.append(os.path.join(kern_doc_dir, "..", "tools")) +sys.path.append(os.path.join(kern_doc_dir, "..", "scripts")) + # Minimal supported version needs_sphinx = "3.4.3" @@ -152,6 +156,7 @@ extensions = [ "maintainers_include", "parser_yaml", "rstFlatTable", + "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx.ext.ifconfig", "translations",