[PATCH v3 4/4] dts: update autodoc sorting order

Luca Vizzarro luca.vizzarro at arm.com
Fri Nov 8 14:45:32 CET 2024


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 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



More information about the dev mailing list