diff mbox series

[v4,4/7] dts: update autodoc sorting order

Message ID 20250303145709.126126-5-Luca.Vizzarro@arm.com (mailing list archive)
State Accepted, archived
Delegated to: Paul Szczepanek
Headers
Series dts: add per-test-suite configuration |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Luca Vizzarro March 3, 2025, 2:57 p.m. UTC 
From: Luca Vizzarro <luca.vizzarro@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@arm.com>
Reviewed-by: Paul Szczepanek <paul.szczepanek@arm.com>
---
 doc/guides/conf.py | 1 +
 1 file changed, 1 insertion(+)

Comments

Dean Marx March 4, 2025, 8:09 p.m. UTC | #1 
Reviewed-by: Dean Marx <dmarx@iol.unh.edu>
diff mbox series

Patch

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