Fix Bug: support or\n and ~ for parameter and return type (#62)

docascode · Oct 13, 2017 · 53068a8 · 53068a8
1 parent 294d490
commit 53068a8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 7 deletions.
diff --git a/docfx_yaml/monkeypatch.py b/docfx_yaml/monkeypatch.py
@@ -1,3 +1,4 @@
+import re
 from docutils import nodes
 from functools import partial
 
@@ -206,9 +207,9 @@ def extract_exception_desc(field_object):
                         returntype_ret = transform_node(returntype_node)
                         if returntype_ret:
                             # Support or in returntype
-                            for returntype in returntype_ret.split(' or '):
-                                # Remove @ and \n for cross reference in return type to apply to docfx correctly
-                                if returntype.startswith('@'):
+                            for returntype in re.split(' or[ \n]', returntype_ret):
+                                # Remove @ ~ and \n for cross reference in return type to apply to docfx correctly
+                                if returntype.startswith('@') or returntype.startswith('~'):
                                     returntype = returntype[1:]
                                 data['return'].setdefault('type', []).append(returntype.rstrip('\n'))
                 if fieldtype.name == 'returnvalue':
@@ -227,9 +228,10 @@ def extract_exception_desc(field_object):
                         _para_types = [] 
                         if fieldtype.name == 'parameter':
                             if _type:
-                                for _s_type in _type.split(' or '):
-                                    # Remove @ and \n for cross reference in parameter type to apply to docfx correctly
-                                    if _s_type and _s_type.startswith('@'):
+                                # Support or in parameter type
+                                for _s_type in re.split(' or[ \n]', _type):
+                                    # Remove @ ~ and \n for cross reference in parameter type to apply to docfx correctly
+                                    if _s_type and (_s_type.startswith('@') or _s_type.startswith('~')):
                                         _s_type = _s_type[1:]
                                         _s_type = _s_type.rstrip('\n')
 

diff --git a/setup.py b/setup.py
@@ -13,7 +13,7 @@
 
 setup(
     name='sphinx-docfx-yaml',
-    version='1.2.22',
+    version='1.2.23',
     author='Eric Holscher',
     author_email='eric@ericholscher.com',
     url='https://github.com/ericholscher/sphinx-docfx-yaml',