py2docfx 0.1.11.dev1965199__py3-none-any.whl → 0.1.11.dev1971898__py3-none-any.whl

py2docfx/docfx_yaml/convert_class.py

@@ -23,6 +23,7 @@ def convert_class(obj):
         'name': old_class_object.get('name', None),
         'fullName': old_class_object.get('fullName', None),
         'module': old_class_object.get('module', None),
+        'inheritances': list(map(lambda x: x.get('type', None), old_class_object.get('inheritance', []))),
         'summary': old_class_object.get('summary', None),
         'constructor': None,
         'variables': None,

py2docfx/docfx_yaml/convert_enum.py

@@ -23,14 +23,17 @@ def convert_enum(obj):
         'summary': old_enum_object.get('summary', None),
         'module': old_enum_object.get('module', None),
         'remarks': old_enum_object.get('remarks', None),
+        'constructor': None,
         'variables': None,
+        'inheritances': list(map(lambda x: x.get('type', None), old_enum_object.get('inheritance', []))),
         'fields': None,
         'metadata': None
     }
 
-    _, variables = get_constructor_and_variables(
+    constructor, variables = get_constructor_and_variables(
         old_enum_object.get('syntax', {}), reference_mapping)
 
+    new_enum_object['constructor'] = constructor
     new_enum_object['variables'] = variables
 
     children = old_enum_object.get('children', [])

py2docfx/docfx_yaml/tests/roots/test-translator-contents/code_with_docstring.py

@@ -26,4 +26,11 @@ class ClassWithCodeSummary:
             }
         ]
     }
+    """
+
+class ClassWithMailLinkSummary:
+    """
+    A mail link: foo@boo.com
+    A string mistaken as mail link: '@search.score'
+    An escaped string: '\@search.score'
     """

py2docfx/docfx_yaml/tests/test_translator_contents.py

@@ -42,3 +42,23 @@ def test_classWithCodeSummary_checkLastLineBracket(app):
     summary = app.env.docfx_info_field_data[objectToGenXml]['summary']
     summaryList = [line for line in summary.splitlines() if line]
     assert (summaryList[-1] == '}') # Translator shouldn't skip last line of bracket (even there's no alphabet =or digit in this line)
+
+@pytest.mark.sphinx('dummy', testroot='translator-contents')
+def test_classWithCodeSummary_checkLastLineBracket(app):
+    # Test data definition
+    objectToGenXml = 'code_with_docstring.ClassWithMailLinkSummary'
+    objectToGenXmlType = 'class'        
+
+    # Arrange
+    prepare_app_envs(app, objectToGenXml)
+    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
+    
+    # Act
+    translator(app, '', doctree)
+
+    # Assert
+    summary = app.env.docfx_info_field_data[objectToGenXml]['summary']
+    summaryList = [line for line in summary.splitlines() if line]
+    assert summaryList[0] == 'A mail link: <xref:mailto:foo@boo.com>'
+    assert summaryList[1] == "A string mistaken as mail link: <xref:mailto:'@search.score>'"
+    assert summaryList[2] == "An escaped string: '@search.score'"

{py2docfx-0.1.11.dev1965199.dist-info → py2docfx-0.1.11.dev1971898.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.11.dev1965199
+Version: 0.1.11.dev1971898
 Summary: A package built based on Sphinx which download source code package and generate yaml files supported by docfx.
 Author: Microsoft Corporation
 License: MIT License

{py2docfx-0.1.11.dev1965199.dist-info → py2docfx-0.1.11.dev1971898.dist-info}/RECORD

@@ -56,8 +56,8 @@ py2docfx/docfx_yaml/__init__.py,sha256=KCEizAXv-SXtrYhvFfLHdBWDhz51AA9uagaeTL-It
 py2docfx/docfx_yaml/build_finished.py,sha256=Oj6gG80L_58yksy1r6n2QAshF9gkngdS0fzglN6XvCc,13532
 py2docfx/docfx_yaml/build_init.py,sha256=lAw-fnBVQbySfZ7Sut_NpFQUjnqLOmnGQrTBBH2RXcg,1860
 py2docfx/docfx_yaml/common.py,sha256=UN1MUmjUoN1QSFDR1Cm_bfRuHr6FQiOe5VQV6s8xzjc,6841
-py2docfx/docfx_yaml/convert_class.py,sha256=xwSFnxMI9t4-ORxdJFAuNdfGTpREoj6yZNaeicyjtgs,2042
-py2docfx/docfx_yaml/convert_enum.py,sha256=wIQpDnJCumRuapbxeNE-78Iq5ai3lWf3Nafya7FFNb8,1876
+py2docfx/docfx_yaml/convert_class.py,sha256=tkaZVVuwycpZcJTDjIBHK1w_HyKSU2mryWZpH1PCJQM,2150
+py2docfx/docfx_yaml/convert_enum.py,sha256=S7sWxamRj8TIF0CT0ovOz2EPaIeT3_-MlnV2u0jiRPI,2073
 py2docfx/docfx_yaml/convert_module.py,sha256=IFd9hFr7tTmkJ4gdeAyRS1B99t31K1Adf1G1w1mRjOI,2140
 py2docfx/docfx_yaml/convert_package.py,sha256=E7p-kCgvfTrY3auJq-zIk-Z1WnUGy7VpfnQU2HPzhNs,1990
 py2docfx/docfx_yaml/directives.py,sha256=zVVuNM_6AU9G6sbqL1UAyHHgPe7bkBWbthXI-PO5ez0,879
@@ -78,7 +78,7 @@ py2docfx/docfx_yaml/tests/test_build_finished.py,sha256=PSyWuY_XWmNeSjQl4kBwHUWp
 py2docfx/docfx_yaml/tests/test_method_arguments.py,sha256=Cvj9aoADtacKciVN8nempXW-KQL8nujSa9GNVuk6l_8,1578
 py2docfx/docfx_yaml/tests/test_numpy_syntax.py,sha256=ssb3J_-Jzjybhh4eycCA_LkXbGflyZyIUAiTjlEYLiw,863
 py2docfx/docfx_yaml/tests/test_translator_attributes.py,sha256=qZCsQGffq31k3UzpXkJpycplOXIq9gi2SxY6vu0DTfw,5224
-py2docfx/docfx_yaml/tests/test_translator_contents.py,sha256=lVCWbBIQk2oPFqsKK9gIb-b5DixutMabWjP7x03oj4s,1746
+py2docfx/docfx_yaml/tests/test_translator_contents.py,sha256=d7cjpZI5Uo71BMxXmW_vYtpM6QBcOqS-MX504Acrvbo,2589
 py2docfx/docfx_yaml/tests/test_translator_data.py,sha256=zSVs3AT_TeAx1mrEYNTpy3Xy-FPrwwi93ly2EFclw5U,984
 py2docfx/docfx_yaml/tests/test_translator_exceptions.py,sha256=A2zAcJOBGchDBNIDr15uD3lzLfVldJKYSAl0e1CD5Ds,10481
 py2docfx/docfx_yaml/tests/test_translator_fieldlists.py,sha256=tDJ1l0c16oYfAlEIcidqEMwaXcX83Fg-rajpLtb2Wnk,1198
@@ -100,7 +100,7 @@ py2docfx/docfx_yaml/tests/roots/test-translator-attributes/code_with_docstring3.
 py2docfx/docfx_yaml/tests/roots/test-translator-attributes/code_with_import.py,sha256=VySauK2eitQYigPZUsrlK8l4ab2SJPOYPQnBoKHgLTo,297
 py2docfx/docfx_yaml/tests/roots/test-translator-attributes/conf.py,sha256=rFV8j1gOtlc2ubfcNf-qi6F1904_G4jMd_5e2fLzip0,358
 py2docfx/docfx_yaml/tests/roots/test-translator-attributes/refered_objects.py,sha256=DJaX52mnHw9W3GSqKh75CYK87g4CczXNNjFO496Ai2U,79
-py2docfx/docfx_yaml/tests/roots/test-translator-contents/code_with_docstring.py,sha256=yPH0kaYzmroxuCO3ZRq5KLb10IqxqROY4io0B58Welc,712
+py2docfx/docfx_yaml/tests/roots/test-translator-contents/code_with_docstring.py,sha256=hnERD63KpGPCaFklE6rOIjr2EhMvpUy17jeRX-XdKA4,889
 py2docfx/docfx_yaml/tests/roots/test-translator-contents/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
 py2docfx/docfx_yaml/tests/roots/test-translator-data/code_with_data.py,sha256=F5-o_cBTjLGzUmk2PEEY60zQz7B0YLe4-yDbEZrvwac,372
 py2docfx/docfx_yaml/tests/roots/test-translator-data/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
@@ -123,7 +123,7 @@ py2docfx/docfx_yaml/tests/roots/test-writer-uri/conf.py,sha256=avcbnIOV2mlGQwhMQ
 py2docfx/docfx_yaml/tests/roots/test-writer-versions/code_with_version_directives.py,sha256=UuizbrJPaG_PcaH18BvbI9KQevOaLd4SslpnzMSqcrE,1030
 py2docfx/docfx_yaml/tests/roots/test-writer-versions/conf.py,sha256=SCEKrm9VigArfdgf-GAieJD-40d0ctT6urmGIjFOZLM,404
 py2docfx/docfx_yaml/tests/utils/test_utils.py,sha256=d0OYSUQ6NyoZx5mlLdNGGNhiNmmQhjVT4hQ6jY3VE_M,3383
-py2docfx-0.1.11.dev1965199.dist-info/METADATA,sha256=rgC5qRIx3h5iuKBvUCx20OUfMkcht03o1olcTcSshpo,601
-py2docfx-0.1.11.dev1965199.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-py2docfx-0.1.11.dev1965199.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.11.dev1965199.dist-info/RECORD,,
+py2docfx-0.1.11.dev1971898.dist-info/METADATA,sha256=jjpjQyGC51shGObN_lm3vqv7QSQ1jVyJiqTxfvVUjI0,601
+py2docfx-0.1.11.dev1971898.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+py2docfx-0.1.11.dev1971898.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.11.dev1971898.dist-info/RECORD,,