Merge pull request #38 from ericholscher/jinhwa/support_enum

add enum desc to summary (temp solution, need refine in future)

docfx_yaml/extension.py

@@ -460,6 +460,12 @@ def convert_module_to_package_if_needed(obj):
                     if 'example' in obj['syntax'] and obj['syntax']['example']:
                         obj.setdefault('example', []).append(obj['syntax'].pop('example'))
 
+                    # append 'enum_attribute' to summary
+                    if 'enum_attribute' in obj['syntax'] and obj['syntax']['enum_attribute']:
+                        enum_attribute = obj['syntax'].pop('enum_attribute')
+                        if 'summary' in obj:
+                            obj['summary'] += ('\n\n' + '\n\n'.join(enum_attribute) + '\n')
+
                 if 'references' in obj:
                     references.extend(obj.pop('references'))
 

docfx_yaml/monkeypatch.py

@@ -6,6 +6,7 @@
 from sphinx import directives, addnodes
 from sphinx import addnodes
 
+from sphinx.addnodes import desc, desc_signature
 from .utils import transform_node as _transform_node
 
 
@@ -26,6 +27,14 @@ def _get_desc_data(node):
     return full_name, uid
 
 
+def _is_desc_of_enum_class(node):
+    assert node.tagname == 'desc_content'
+    if node[0] and node[0].tagname == 'paragraph' and node[0].astext() == 'Bases: enum.Enum':
+        return True
+
+    return False
+
+
 def _hacked_transform(typemap, node):
     """
     Taken from docfields.py from sphinx.
@@ -208,6 +217,11 @@ def transform_all(self, node):
             name, uid = _get_desc_data(node.parent)
             for child in node:
                 if isinstance(child, addnodes.desc):
+                    if _is_desc_of_enum_class(node):
+                        for item in child:
+                            if isinstance(item, desc_signature):
+                                data.setdefault('enum_attribute', []).append(item.astext())
+
                     # Don't recurse into child nodes
                     continue
                 elif isinstance(child, nodes.field_list):