From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E85C045CB3; Fri, 8 Nov 2024 14:46:01 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 29E8B433EF; Fri, 8 Nov 2024 14:45:45 +0100 (CET) Received: from foss.arm.com (foss.arm.com [217.140.110.172]) by mails.dpdk.org (Postfix) with ESMTP id 948B7433CC for ; Fri, 8 Nov 2024 14:45:41 +0100 (CET) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 08DD5497; Fri, 8 Nov 2024 05:46:11 -0800 (PST) Received: from localhost.localdomain (unknown [10.57.59.19]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPA id 7A54D3F528; Fri, 8 Nov 2024 05:45:40 -0800 (PST) From: Luca Vizzarro To: dev@dpdk.org Cc: Paul Szczepanek , Patrick Robb , Luca Vizzarro Subject: [PATCH v3 4/4] dts: update autodoc sorting order Date: Fri, 8 Nov 2024 13:45:32 +0000 Message-ID: <20241108134532.130681-5-luca.vizzarro@arm.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20241108134532.130681-1-luca.vizzarro@arm.com> References: <20240906161355.701688-1-luca.vizzarro@arm.com> <20241108134532.130681-1-luca.vizzarro@arm.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The autodoc member sorting order default is set to alphabetical, which translates to autodoc sorting every member in modules, classes etc. This also brings some side effects, like sorting capabilities which can't be compared and result in errors. This change prevents autodoc from sorting, and keeping the order as the developer intended it. Signed-off-by: Luca Vizzarro Reviewed-by: Paul Szczepanek --- doc/guides/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 71fed45b3d..ed5bc5eb30 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -88,6 +88,7 @@ autodoc_typehints = 'both' autodoc_typehints_format = 'short' autodoc_typehints_description_target = 'documented' + autodoc_member_order = 'bysource' # Intersphinx allows linking to external projects, such as Python docs. intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} -- 2.43.0