linux-kernel - Re: [PATCH 02/13] docs: enable Sphinx autodoc extension to allow documenting python

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <8e5e9257091275c6a3ddbbb254ca15ed55020627@intel.com>
Date: Thu, 15 Jan 2026 12:19:48 +0200
From: Jani Nikula <jani.nikula@...ux.intel.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Jonathan Corbet
 <corbet@....net>, Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 linux-kernel@...r.kernel.org, Mauro Carvalho Chehab <mchehab@...nel.org>,
 Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH 02/13] docs: enable Sphinx autodoc extension to allow
 documenting python

On Wed, 14 Jan 2026, Mauro Carvalho Chehab <mchehab+huawei@...nel.org> wrote:
> 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 <mchehab+huawei@...nel.org>
> ---
>  Documentation/conf.py | 11 ++++++++---
>  1 file changed, 8 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 1ea2ae5c6276..429fcc9fd7f7 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -13,11 +13,18 @@ from  textwrap import dedent
>  
>  import sphinx
>  
> +# Location of Documentation/ directory
> +doctree = os.path.abspath(".")

Looking this up based on __file__ would be more robust than cwd.

Calling this doctree is misleading because doctree is a specific Sphinx
term that means something else. The doctree directory is where the
parsed and pickled documents are cached.

Oh, I see that you're just moving this, but this is something that
should be fixed first.

> +
>  # If extensions (or modules to document with autodoc) are in another directory,
>  # add these directories to sys.path here. If the directory is relative to the
>  # documentation root, use os.path.abspath to make it absolute, like shown here.
>  sys.path.insert(0, os.path.abspath("sphinx"))
>  
> +# Allow sphinx.ext.autodoc to document from tools and scripts
> +sys.path.append(f"{doctree}/../tools")
> +sys.path.append(f"{doctree}/../scripts")

These would be much nicer with pathlib.Path.

> +
>  # Minimal supported version
>  needs_sphinx = "3.4.3"
>  
> @@ -32,9 +39,6 @@ else:
>      # Include patterns that don't contain directory names, in glob format
>      include_patterns = ["**.rst"]
>  
> -# Location of Documentation/ directory
> -doctree = os.path.abspath(".")
> -
>  # Exclude of patterns that don't contain directory names, in glob format.
>  exclude_patterns = []
>  
> @@ -151,6 +155,7 @@ extensions = [
>      "maintainers_include",
>      "parser_yaml",
>      "rstFlatTable",
> +    "sphinx.ext.autodoc",
>      "sphinx.ext.autosectionlabel",
>      "sphinx.ext.ifconfig",
>      "translations",

-- 
Jani Nikula, Intel