py2docfx 0.1.3rc1683981__py3-none-any.whl → 0.1.4__py3-none-any.whl

py2docfx/docfx_yaml/tests/roots/test-writer-versions/code_with_version_directives.py

@@ -0,0 +1,43 @@
+class testClassA():
+    """Test Class A
+
+    some summary to ensure class parameters and constructor parametes are put in two field lists 
+    
+    :ivar bool var1:
+        description 1
+
+        .. versionadded:: 0.0.2
+
+    .. versionadded:: 0.0.1
+        Description versionadd
+
+    """
+    def method(self) -> None:
+        
+        """
+        Summary
+        
+        .. versionchanged:: 0.0.1
+
+        :param str param1:
+            Description
+            
+            .. versionadded:: 1.0.0           
+            .. versionchanged:: 0.0.3
+        :param param2: 
+            description
+            
+            .. versionadded:: 0.0.2
+        :type param2: int
+        :keyword bool kw1:
+            Description of kw1
+            
+            .. versionadded:: 0.0.2 
+            .. versionchanged:: 0.0.3
+        .. versionadded:: 0.1.0
+            description 1
+        .. versionadded:: 0.2.0
+            description 2
+        .. deprecated:: 1.1.0
+        """
+        pass

py2docfx/docfx_yaml/tests/roots/test-writer-versions/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'
+]
+
+pygments_style = 'sphinx'
+
+napoleon_use_admonition_for_examples = True
+
+nitpicky = True
+
+autoclass_content = 'both'

py2docfx/docfx_yaml/tests/test_writer_versions.py

@@ -0,0 +1,57 @@
+import pytest
+from sphinx.testing import restructuredtext
+from sphinx.io import SphinxStandaloneReader
+from sphinx import addnodes
+
+from translator import translator
+from py2docfx.docfx_yaml.tests.utils.test_utils import prepare_app_envs,prepare_refered_objects,load_rst_transform_to_doctree
+
+def helper_assert_summary_contains_italic(summary, enclosed):
+    assert '*' + enclosed + '*' in summary.replace('\n','')
+
+@pytest.mark.sphinx('yaml', testroot='writer-versions')
+def test_version_directives_should_be_italic(app):
+    # Test data definition
+    objectToGenXml = 'code_with_version_directives.testClassA'
+    objectToGenXmlType = 'class'        
+
+    # Arrange
+    prepare_app_envs(app, objectToGenXml)
+    doctree = load_rst_transform_to_doctree(app, objectToGenXmlType, objectToGenXml)
+    
+    # Act
+    translator(app, '', doctree)
+    
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA']['summary'],
+        'New in version 0.0.1:')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA']['variables'][0]['description'],
+        'New in version 0.0.2.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['summary'],
+        'Changed in version 0.0.1.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['summary'],
+        'New in version 0.1.0:')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['summary'],
+        'New in version 0.2.0:')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['summary'],
+        'Deprecated since version 1.1.0.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['parameters'][0]['description'],
+        'New in version 1.0.0.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['parameters'][0]['description'],
+        'Changed in version 0.0.3.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['parameters'][1]['description'],
+        'New in version 0.0.2.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['keywordOnlyParameters'][0]['description'],
+        'New in version 0.0.2.')
+    helper_assert_summary_contains_italic(
+        app.env.docfx_info_field_data['code_with_version_directives.testClassA.method']['keywordOnlyParameters'][0]['description'],
+        'Changed in version 0.0.3.')

py2docfx/docfx_yaml/write_utils.py

@@ -0,0 +1,6 @@
+def is_inline_text_children_of_versionmodified(node):
+    if hasattr(node, 'parent') and node.parent is not None:
+        if hasattr(node.parent, 'parent') and node.parent.parent is not None:
+            if node.parent.parent.tagname == 'versionmodified':
+                return True
+    return False

py2docfx/docfx_yaml/writer.py

@@ -31,6 +31,7 @@ from sphinx import addnodes
 from sphinx.locale import admonitionlabels
 
 from nodes import remarks
+import write_utils
 
 class bcolors:
     HEADER = '\033[95m'
@@ -1044,6 +1045,8 @@ class MarkdownTranslator(nodes.NodeVisitor):
 
     def visit_Text(self, node):
         text = self.replace_special_unicode(node.astext())
+        if write_utils.is_inline_text_children_of_versionmodified(node.parent):
+            text = text.strip(' ')
         self.add_text(text)
 
     def depart_Text(self, node):
@@ -1058,10 +1061,14 @@ class MarkdownTranslator(nodes.NodeVisitor):
     def visit_inline(self, node):
         if 'xref' in node['classes'] or 'term' in node['classes']:
             self.add_text('*')
+        elif write_utils.is_inline_text_children_of_versionmodified(node):
+            self.add_text('*')
 
     def depart_inline(self, node):
         if 'xref' in node['classes'] or 'term' in node['classes']:
             self.add_text('*')
+        elif write_utils.is_inline_text_children_of_versionmodified(node):
+            self.add_text('* ')
 
     def visit_container(self, node):
         pass

{py2docfx-0.1.3rc1683981.dist-info → py2docfx-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.3rc1683981
+Version: 0.1.4
 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.3rc1683981.dist-info → py2docfx-0.1.4.dist-info}/RECORD

@@ -69,7 +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=li20Sdu-j1V7oK1iaxWw9mo0KSJOlh4FLSnwmu6UxBQ,25912
 py2docfx/docfx_yaml/utils.py,sha256=m5jC_qP2NKqzUx_z0zgZ-HAmxQdNTpJYKkL_F9vGeII,1555
-py2docfx/docfx_yaml/writer.py,sha256=0ZqyVGDHa4Cr3NsuOPRf4pGUStl6g6IBxpSgIZeDT9I,34683
+py2docfx/docfx_yaml/write_utils.py,sha256=q5qoYWw6GVDV8a3E8IxcSLWnN9sAer42VFRgadHBkgk,305
+py2docfx/docfx_yaml/writer.py,sha256=BQ02TshJM7O53_n07i_DJ-WtI7PYNyBJ2OLzivq4iiA,35037
 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,6 +87,7 @@ py2docfx/docfx_yaml/tests/test_translator_rst_returns.py,sha256=BL3nOMMTPzNPJk-P
 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_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
 py2docfx/docfx_yaml/tests/roots/test-method-arguments/code_with_all_arg_types.py,sha256=jK4M4ejeVWedhHJ_s9L9wEEqJmk0wOF8-yuoIaA6fZU,322
@@ -118,8 +120,10 @@ py2docfx/docfx_yaml/tests/roots/test-writer-table/code_with_table_desc.py,sha256
 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/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.3rc1683981.dist-info/METADATA,sha256=6d8xvbII9LL3cPR5IdT_ZOJ8kx9-JjW2En00cFO_HjQ,599
-py2docfx-0.1.3rc1683981.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-py2docfx-0.1.3rc1683981.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.3rc1683981.dist-info/RECORD,,
+py2docfx-0.1.4.dist-info/METADATA,sha256=zAcVIHMUEILG27sqpj5-Ger1BeKR2gFzTGnu8IxMp9E,590
+py2docfx-0.1.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+py2docfx-0.1.4.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.4.dist-info/RECORD,,