Merge pull request #92 from ehennestad/main

Update doctools to sort specification keys of embedded yaml in HDMF-preferred order

Author: oruebel

hdmf_docutils/doctools/rst.py

@@ -290,11 +290,18 @@ def spec_to_yaml(spec):
         import json
         from ruamel.yaml import YAML
         from ruamel.yaml.compat import StringIO
-        clean_spec = json.loads(json.dumps(spec, sort_keys=True, indent=4, separators=(',', ': ')))
+        from hdmf.spec.write import YAMLSpecWriter
+        
+        # Convert to plain dict first
+        clean_spec = json.loads(json.dumps(spec, indent=4, separators=(',', ': ')))
+        # Sort keys using YAMLSpecWriter's sort_keys method
+        hdmf_yaml_writer = YAMLSpecWriter()
+        sorted_spec = hdmf_yaml_writer.sort_keys(clean_spec)
+        
         yaml = YAML(pure=True)
         yaml.default_flow_style = False
         stream = StringIO()
-        yaml.dump(clean_spec, stream)
+        yaml.dump(sorted_spec, stream)
         return stream.getvalue()
 
     def add_spec(self, spec):