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

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

@@ -17,5 +17,12 @@ 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_writer_uri.py

@@ -20,6 +20,7 @@ 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))
@@ -28,7 +29,10 @@ 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/writer.py

@@ -183,6 +183,15 @@ 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)
@@ -925,7 +934,10 @@ class MarkdownTranslator(nodes.NodeVisitor):
                             match_content_issue_pattern = True
                             ref_string = node.attributes["refuri"]
                 if not match_content_issue_pattern:
-                    ref_string = '[{}]({})'.format(node.astext(), node.attributes['refuri'])
+                    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'])
             else:
                 # only use id in class and func refuri if its id exists
                 # otherwise, remove '.html#' in refuri

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

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

@@ -70,7 +70,7 @@ py2docfx/docfx_yaml/settings.py,sha256=JQZNwFebczl-zn8Yk2taAGANRi-Hw8hywtDWxqXXF
 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=BQ02TshJM7O53_n07i_DJ-WtI7PYNyBJ2OLzivq4iiA,35037
+py2docfx/docfx_yaml/writer.py,sha256=UMdqVym5WJVLuNOfB1o9Xh7jgwVTtpKutjly4Ts6OAo,35689
 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
@@ -86,7 +86,7 @@ py2docfx/docfx_yaml/tests/test_translator_numpy_returns.py,sha256=nmC70WUqCRcB1t
 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=L9eFHZndD6H7nkznJ9Bw0v8xh9IegDlhhGFHBz9EHmM,1745
+py2docfx/docfx_yaml/tests/test_writer_uri.py,sha256=-TsN_eWEWzWpFy8xGnxPWP2Oqb8ikvI_Y4Syl4PVhMI,2091
 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
@@ -118,12 +118,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=bzWTZpY2yf_By2bOSl1GFaY3BsZpkAvwQuGztlcHKkQ,537
+py2docfx/docfx_yaml/tests/roots/test-writer-uri/code_with_uri.py,sha256=GSz1B0xiXSaddkrniVBXzW7R4jDuPq1sWU7ByBH6MxA,754
 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.dev1912073.dist-info/METADATA,sha256=dp7RFy__EgLP0u45Jf6WovUwnvMf8tHoedy4AAd_J4Q,601
-py2docfx-0.1.11.dev1912073.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-py2docfx-0.1.11.dev1912073.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.11.dev1912073.dist-info/RECORD,,
+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.dev1912073.dist-info → py2docfx-0.1.11.dev1917708.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.44.0)
+Generator: bdist_wheel (0.45.0)
 Root-Is-Purelib: true
 Tag: py3-none-any