py2docfx 0.1.11.dev1917708__py3-none-any.whl → 0.1.11.dev1919119__py3-none-any.whl

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

@@ -26,4 +26,9 @@ class ClassWithCodeSummary:
             }
         ]
     }
+    """
+
+class ClassWithAngleBracketSummary:
+    """
+    Test Method with param docstring containing angle bracket: link https://<variable>.foo.net/boo
     """

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

@@ -3,7 +3,7 @@ import sys
 
 sys.path.insert(0, os.path.abspath('.'))
 
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'yaml_builder']
 
 class includeTest:
     pass

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

@@ -0,0 +1,19 @@
+class TestClassA():
+    """Test Class A
+    some summary to ensure class parameters and constructor parametes are put in two field lists 
+
+    """
+    def __init__(self) -> None:
+        pass
+    
+    def method_param_docstring_contain_angle_bracket(self):
+        """Test Method with param docstring containing angle bracket
+        
+        :param str paramE: Test Param E, link https://<variable>.foo.net/boo
+        """
+        pass
+
+    def method_docstring_contain_angle_bracket(self):
+        """Test Method with param docstring containing angle bracket: link https://<variable>.foo.net/boo
+        """
+        pass

py2docfx/docfx_yaml/tests/roots/test-translator-method/conf.py

@@ -0,0 +1,24 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('.'))
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'yaml_builder']
+
+class includeTest:
+    pass
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+autodoc_mock_imports = [
+    'dummy'
+]
+
+nitpicky = True
+
+autodoc_default_options = {
+    'inherited-members': True
+}
+
+napoleon_preprocess_types = True

py2docfx/docfx_yaml/tests/roots/test-writer-uri/code_with_uri.py

@@ -17,12 +17,5 @@ class SampleClass():
         """
         pass
 
-    def dummy_summary3(self):
-        """
-        This is a bare URL that shouldn't be transformed into a link
-        because it's in the exclusion list: https://management.azure.com
-        """
-        pass
-
     pass
     

py2docfx/docfx_yaml/tests/test_translator_contents.py

@@ -42,3 +42,21 @@ 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('yaml', testroot='translator-contents')
+def test_classWithAngleBracketSummary_checkSummary(app):
+    # Test data definition
+    objectToGenXml = 'code_with_docstring.ClassWithAngleBracketSummary'
+    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']
+    assert summary == 'Test Method with param docstring containing angle bracket: link [https:/](https:/)/<variable>.foo.net/boo'

py2docfx/docfx_yaml/tests/test_translator_method.py

@@ -0,0 +1,42 @@
+import pytest
+
+from sphinx.testing import restructuredtext
+from sphinx.io import SphinxStandaloneReader
+from sphinx import addnodes
+from translator import translator
+
+from .utils.test_utils import prepare_app_envs,load_rst_transform_to_doctree
+
+@pytest.mark.sphinx('yaml', testroot='translator-method')
+def test_paramDocstringContainingAngleBrackets_checkEncoded(app):
+    # Test data definition
+    objectToGenXml = 'code_with_docstring.TestClassA.method_param_docstring_contain_angle_bracket'
+    objectToGenXmlType = 'function'
+
+    # 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]['parameters'][0]['description']
+    assert (summary == '**paramE** (<xref:str>) -- Test Param E, link [https:/](https:/)/&lt;variable&gt;.foo.net/boo')
+
+@pytest.mark.sphinx('yaml', testroot='translator-method')
+def test_docstringContainingAngleBrackets_checkEncoded(app):
+    # Test data definition
+    objectToGenXml = 'code_with_docstring.TestClassA.method_docstring_contain_angle_bracket'
+    objectToGenXmlType = 'function'
+
+    # 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']
+    assert summary == 'Test Method with param docstring containing angle bracket: link [https:/](https:/)/&lt;variable&gt;.foo.net/boo'

py2docfx/docfx_yaml/tests/test_writer_uri.py

@@ -20,7 +20,6 @@ def test_http_link_in_summary_should_not_nest_parenthesis(app):
     class_summary_result = transform_node(app, doctree[1][1][0])
     method1_summary_result = transform_node(app, doctree[1][1][2][1])
     method2_summary_result = transform_node(app, doctree[1][1][4][1])
-    method3_summary_result = transform_node(app, doctree[1][1][6][1])
 
     # Assert
     # Shouldn't see something like [title]((link))
@@ -29,10 +28,7 @@ def test_http_link_in_summary_should_not_nest_parenthesis(app):
                                "We should not generate nested parenthesis causing docs validation warnings\n")
     method2_summary_expected = ("\n\n   This isn't a content issue link ([https://www.microsoft.com](https://www.microsoft.com))\n   "
                                 "Should expect a transformed Markdown link.\n")
-    method3_summary_expected = ("\n\n   This is a bare URL that shouldn't be transformed into a link\n   "
-                                "because it's in the exclusion list: https://management.azure.com\n")
     assert(class_summary_expected == class_summary_result)
     assert(method1_summary_expected == method1_summary_result)
     assert(method2_summary_expected == method2_summary_result)
-    assert(method3_summary_expected == method3_summary_result)
     

py2docfx/docfx_yaml/write_utils.py

@@ -3,4 +3,15 @@ def is_inline_text_children_of_versionmodified(node):
         if hasattr(node.parent, 'parent') and node.parent.parent is not None:
             if node.parent.parent.tagname == 'versionmodified':
                 return True
-    return False
+    return False
+
+def replace_special_unicode(text):
+    text = text.replace('\u201c', '"')
+    text = text.replace('\u201d', '"')
+    text = text.replace('\u2018', "'")
+    text = text.replace('\u2019', "'")
+    text = text.replace('\u2026', "...")
+    return text
+
+def replace_angle_brackets_with_html_entities(text):
+    return text.replace('<', '&lt;').replace('>', '&gt;')

py2docfx/docfx_yaml/writer.py

@@ -183,15 +183,6 @@ class MarkdownTranslator(nodes.NodeVisitor):
     sectionchars = '*=-~"+`'
     xref_template = "<xref:{0}>"
 
-    # URLs that shouldn't be automatically rendered as hyperlinks if found bare. Included because they appear
-    # frequently, get flagged by the broken link validator and/or there's no value to the user in
-    # making them clickable links.
-    urls_that_shouldnt_be_rendered_as_links = {
-        "https://management.azure.com",
-        "https://management.chinacloudapi.cn",
-        "https://management.usgovcloudapi.net"
-        }
-
     def __init__(self, document, builder):
         self.invdata = []
         nodes.NodeVisitor.__init__(self, document)
@@ -934,10 +925,7 @@ class MarkdownTranslator(nodes.NodeVisitor):
                             match_content_issue_pattern = True
                             ref_string = node.attributes["refuri"]
                 if not match_content_issue_pattern:
-                    if inner_text == node.attributes['refuri'] and inner_text in cls.urls_that_shouldnt_be_rendered_as_links:
-                        ref_string = inner_text
-                    else:
-                        ref_string = '[{}]({})'.format(node.astext(), node.attributes['refuri'])
+                    ref_string = '[{}]({})'.format(node.astext(), node.attributes['refuri'])
             else:
                 # only use id in class and func refuri if its id exists
                 # otherwise, remove '.html#' in refuri
@@ -1056,7 +1044,8 @@ class MarkdownTranslator(nodes.NodeVisitor):
         return text
 
     def visit_Text(self, node):
-        text = self.replace_special_unicode(node.astext())
+        text = write_utils.replace_special_unicode(node.astext())
+        text = write_utils.replace_angle_brackets_with_html_entities(text)
         if write_utils.is_inline_text_children_of_versionmodified(node.parent):
             text = text.strip(' ')
         self.add_text(text)

{py2docfx-0.1.11.dev1917708.dist-info → py2docfx-0.1.11.dev1919119.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.11.dev1917708
+Version: 0.1.11.dev1919119
 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.dev1917708.dist-info → py2docfx-0.1.11.dev1919119.dist-info}/RECORD

@@ -69,8 +69,8 @@ py2docfx/docfx_yaml/return_type_utils.py,sha256=nmdCUOvwdYk2jF6RqmOvU6gjXmXUTPUe
 py2docfx/docfx_yaml/settings.py,sha256=JQZNwFebczl-zn8Yk2taAGANRi-Hw8hywtDWxqXXFyQ,373
 py2docfx/docfx_yaml/translator.py,sha256=IXxrOEF2L1gZjGciimyrNHRHQUf1Xy3vr2UUR5i2vyM,25961
 py2docfx/docfx_yaml/utils.py,sha256=m5jC_qP2NKqzUx_z0zgZ-HAmxQdNTpJYKkL_F9vGeII,1555
-py2docfx/docfx_yaml/write_utils.py,sha256=q5qoYWw6GVDV8a3E8IxcSLWnN9sAer42VFRgadHBkgk,305
-py2docfx/docfx_yaml/writer.py,sha256=UMdqVym5WJVLuNOfB1o9Xh7jgwVTtpKutjly4Ts6OAo,35689
+py2docfx/docfx_yaml/write_utils.py,sha256=dmE6Jrb8IEkfJ6kv2j0vBHS5qMVi7jbDINPzLurhGZk,677
+py2docfx/docfx_yaml/writer.py,sha256=pIeYdXrU_xGnv6OjEyGYrgDCHt6dBrprYux-YZaaY_4,35120
 py2docfx/docfx_yaml/yaml_builder.py,sha256=qSxXVS4iFCc1ZdL5QzLrv8hy3LHIQCrhO4WcTp01vag,2575
 py2docfx/docfx_yaml/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/docfx_yaml/tests/conftest.py,sha256=CykkZxaDZ-3a1EIQdGBieSmHL9FdyTE2xTJZe9QgKcg,1214
@@ -78,15 +78,16 @@ 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=6Nb0nftqi8YXbmyTMsEKYWVmWc-HWqkiKz7gWNHsxQE,2432
 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
+py2docfx/docfx_yaml/tests/test_translator_method.py,sha256=VQFAUX__WWLmJA6AQPLH8dUnXzeQirdvONZUIwwym-Q,1674
 py2docfx/docfx_yaml/tests/test_translator_numpy_returns.py,sha256=nmC70WUqCRcB1tkRG9iq8mBuIcZKwGhK09StEvq0zf8,2970
 py2docfx/docfx_yaml/tests/test_translator_rst_returns.py,sha256=BL3nOMMTPzNPJk-P9oMANiXnJ7ocuiecbFHH4DU1n40,2942
 py2docfx/docfx_yaml/tests/test_translator_signatures.py,sha256=DM51EOb4UXLkrO1-4cQQQvvX210goAsnxKJH-4A2U2Q,1537
 py2docfx/docfx_yaml/tests/test_writer_table.py,sha256=UnGYXQ-QVxin_e-HGZAHdg1LSFV0qc480ZNsqPN9OYc,1444
-py2docfx/docfx_yaml/tests/test_writer_uri.py,sha256=-TsN_eWEWzWpFy8xGnxPWP2Oqb8ikvI_Y4Syl4PVhMI,2091
+py2docfx/docfx_yaml/tests/test_writer_uri.py,sha256=L9eFHZndD6H7nkznJ9Bw0v8xh9IegDlhhGFHBz9EHmM,1745
 py2docfx/docfx_yaml/tests/test_writer_versions.py,sha256=0-0VTMhbZ4ml9ryu1gYnu0mM2yIEKsBuFYb2F6grzTE,2995
 py2docfx/docfx_yaml/tests/roots/test-build-finished/code_with_signature_and_docstring.py,sha256=qvcKWL68C2aDTP8JT022nMV4EdZ50vhxVshMrHVO2sY,449
 py2docfx/docfx_yaml/tests/roots/test-build-finished/conf.py,sha256=L8vIFmO546PCQks50Gif_uTBwC3cppohXrQaogfyRF8,410
@@ -100,8 +101,8 @@ 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/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
+py2docfx/docfx_yaml/tests/roots/test-translator-contents/code_with_docstring.py,sha256=ffSheCUinQydQqt1Vm4VBaCtf5ECZFUkBG4APCz5xp8,869
+py2docfx/docfx_yaml/tests/roots/test-translator-contents/conf.py,sha256=qnFx2JWf3soFQYBAG1S5jSLNoAjMbeRjsthOIcAenx0,276
 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
 py2docfx/docfx_yaml/tests/roots/test-translator-exceptions/code_with_docstring.py,sha256=vRbnBpO9YFCz7ZlNvUNh7l-ILBiwhzpN2mPm-rtKNQs,3543
@@ -109,6 +110,8 @@ py2docfx/docfx_yaml/tests/roots/test-translator-exceptions/conf.py,sha256=avcbnI
 py2docfx/docfx_yaml/tests/roots/test-translator-exceptions/refered_objects.py,sha256=zTnP-R7nxTxZr2yHurKKQSPFSY9gz3_vmFI0OotI3_U,124
 py2docfx/docfx_yaml/tests/roots/test-translator-fieldlists/code_with_multiple_fieldlists.py,sha256=llu95FRqwjtwrMdR1enMB1Lso59CYJBmUPQy6LvGGAA,502
 py2docfx/docfx_yaml/tests/roots/test-translator-fieldlists/conf.py,sha256=KrvMHOj1LCdodwNwUsdCI_OMM-Bf_lpiUREk4egQWms,388
+py2docfx/docfx_yaml/tests/roots/test-translator-method/code_with_docstring.py,sha256=6V40cvO6Dj85R-bfKDkKlF8FDkfY1p_EAtB6Nh4OKKE,640
+py2docfx/docfx_yaml/tests/roots/test-translator-method/conf.py,sha256=A-QZx8-7Zg3_6X42F3LSyG5Nx0AoYkbKB2QbnM33PB0,402
 py2docfx/docfx_yaml/tests/roots/test-translator-returns/code_with_returns_numpy.py,sha256=OGHOCBmRENAp4_MLYgyUsU2z7cm_hQx6Jtb8PSIs1Uo,748
 py2docfx/docfx_yaml/tests/roots/test-translator-returns/code_with_returns_rst.py,sha256=sQ1gV9lN33NjXFetGrUNLD6qCJF9v7BMYBQnDLa2Kdo,644
 py2docfx/docfx_yaml/tests/roots/test-translator-returns/conf.py,sha256=A-QZx8-7Zg3_6X42F3LSyG5Nx0AoYkbKB2QbnM33PB0,402
@@ -118,12 +121,12 @@ py2docfx/docfx_yaml/tests/roots/test-translator-signatures/conf.py,sha256=avcbnI
 py2docfx/docfx_yaml/tests/roots/test-translator-signatures/refered_objects.py,sha256=DJaX52mnHw9W3GSqKh75CYK87g4CczXNNjFO496Ai2U,79
 py2docfx/docfx_yaml/tests/roots/test-writer-table/code_with_table_desc.py,sha256=J4eFvXsymgFvjnwVUY0APtUGwuxvt-AFJjTaEaQ7zMQ,574
 py2docfx/docfx_yaml/tests/roots/test-writer-table/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
-py2docfx/docfx_yaml/tests/roots/test-writer-uri/code_with_uri.py,sha256=GSz1B0xiXSaddkrniVBXzW7R4jDuPq1sWU7ByBH6MxA,754
+py2docfx/docfx_yaml/tests/roots/test-writer-uri/code_with_uri.py,sha256=bzWTZpY2yf_By2bOSl1GFaY3BsZpkAvwQuGztlcHKkQ,537
 py2docfx/docfx_yaml/tests/roots/test-writer-uri/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
 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.dev1917708.dist-info/METADATA,sha256=YkTpFHkpn8q7txyG9hsXwk0xPsIV_zljimJhBOlYYD0,601
-py2docfx-0.1.11.dev1917708.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
-py2docfx-0.1.11.dev1917708.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.11.dev1917708.dist-info/RECORD,,
+py2docfx-0.1.11.dev1919119.dist-info/METADATA,sha256=nl8d3aHBYbBZ3F5H5wok0s3NbJHjx8dDEvYO-GNSIfc,601
+py2docfx-0.1.11.dev1919119.dist-info/WHEEL,sha256=bFJAMchF8aTQGUgMZzHJyDDMPTO3ToJ7x23SLJa1SVo,92
+py2docfx-0.1.11.dev1919119.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.11.dev1919119.dist-info/RECORD,,