[PATCH v4 4/7] dts: update autodoc sorting order
Luca Vizzarro
Luca.Vizzarro at arm.com
Mon Mar 3 15:57:06 CET 2025
From: Luca Vizzarro <luca.vizzarro at arm.com>
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 <luca.vizzarro at arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek at arm.com>
---
doc/guides/conf.py | 1 +
1 file changed, 1 insertion(+)
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index da139df1bd..565f5705d8 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -87,6 +87,7 @@
autodoc_typehints = 'both'
autodoc_typehints_format = 'short'
autodoc_typehints_description_target = 'documented'
+ autodoc_member_order = 'bysource'
# DTS docstring options.
add_module_names = False
--
2.43.0
More information about the dev
mailing list