py2docfx 0.1.2.dev1649201__py3-none-any.whl → 0.1.2.dev1676273__py3-none-any.whl

py2docfx/convert_prepare/package_info.py

@@ -2,6 +2,7 @@ from enum import Enum
 import os
 import re
 from py2docfx.convert_prepare.source import Source
+from py2docfx.convert_prepare.package_info_extra_settings import extra_exclude_path_by_package
 
 class PackageInfo:
     class InstallType(int, Enum):
@@ -161,4 +162,12 @@ class PackageInfo:
                 if idx != len(package_name_segs)-1:
                     current_parent_packages = f'{current_parent_packages}/{package_seg}' if current_parent_packages else package_seg
                     exclude_path.append(os.path.join(code_location, f'{current_parent_packages}/__init__.py'))
+
+            if self.name in extra_exclude_path_by_package:
+                exclude_path.extend(
+                    [
+                        os.path.join(code_location, path)
+                        for path in extra_exclude_path_by_package[self.name]
+                    ]
+                )
         return exclude_path

py2docfx/convert_prepare/package_info_extra_settings.py

@@ -0,0 +1,20 @@
+"""
+ Sphinx defaultly generate namespace pages liek azure azure-core
+ We have different ways to deal with it compare to Azure SDK scripts
+ We pass --implicit-namespaces to mark parent level namespaces, instead they're defaultly packages
+ We exclude parent namespaces' __init__.py when running sphinx-apidoc otherwise it throws exception
+ Azure SDK scripts don't add the --implicit-namespaces flag
+ They removed parent level RSTs
+ Check https://github.com/Azure/azure-sdk-for-python/blob/efad456552b8e4aa48db7ee96930223b95144947/eng/tox/run_sphinx_apidoc.py#L37C1-L48C10
+
+ That difference causes our behavior differs from Azure SDK html when package name and its namespace
+  structure are inconsistent. For example, azure-core-tracing-opencensus and azure-core-tracing-opentelemetry
+  have layer of azure/core/tracing/ext/opencensus_span or azure/core/tracing/ext/opentelemetry_span,
+  We generates 2 extra pages of azure.core.tracing.ext because we aren't able to know it is a parent level namespace
+
+ Below map worksaround this issue by excluding know extra parent level __init__.py
+"""
+extra_exclude_path_by_package = {
+    'azure-core-tracing-opencensus': ['azure/core/tracing/ext/__init__.py'],
+    'azure-core-tracing-opentelemetry': ['azure/core/tracing/ext/__init__.py'],
+}

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -51,5 +51,4 @@ def test_generate_document(tmp_path):
     assert not os.path.exists(os.path.join(yaml_path, "azure.dummy.yml"))
     assert not os.path.exists(os.path.join(yaml_path, "azure.yml"))
     assert os.path.exists(os.path.join(yaml_path, "toc.yml"))
-    assert os.path.exists(os.path.join(yaml_path, "index.yml"))
 

py2docfx/convert_prepare/tests/test_package_info.py

@@ -13,10 +13,10 @@ with open(full_test_file_path, "r", encoding="utf-8") as json_file:
 package_info_0 = PackageInfo.parse_from(test_dict["packages"][0], False)
 package_info_0.code_location = "dummy_location"
 
-with open(full_test_file_path, "r", encoding="utf-8") as json_file:
-    test_dict = json.load(json_file)
 package_info_1 = PackageInfo.parse_from(test_dict["packages"][1], False)
 
+package_info_2 = PackageInfo.parse_from(test_dict["packages"][2], False)
+
 def test_parse_from():
     assert package_info_0.exclude_path == ["test*", "example*", "sample*", "doc*"]
     assert package_info_0.name == "azure-mltable-py2docfxtest"
@@ -55,3 +55,44 @@ def test_get_exclude_command(tmp_path):
     def form_exclude_path(raletive_path):
         return os.path.join(source_folder, raletive_path)
     assert exclude_path == [form_exclude_path(path) for path in expected_exclude_path]
+
+
+def test_get_exclude_command(tmp_path):
+    source_folder = os.path.join(tmp_path,"source_folder")
+    yaml_output_folder = os.path.join(tmp_path,"yaml_output_folder")
+    package_info_0.path = Source(
+        source_folder = source_folder, yaml_output_folder = yaml_output_folder, package_name = "azure-mltable-py2docfxtest"
+    )
+    exclude_path = package_info_0.get_exluded_command()
+    expected_exclude_path = [
+        "build/*",
+        "setup.py",
+        "test*",
+        "example*",
+        "sample*",
+        "doc*",
+        "azure/__init__.py",
+        "azure/mltable/__init__.py"
+    ]
+    def form_exclude_path(raletive_path):
+        return os.path.join(source_folder, raletive_path)
+    assert exclude_path == [form_exclude_path(path) for path in expected_exclude_path]
+
+def test_get_exclude_command_check_extra_exclude(tmp_path):
+    source_folder = os.path.join(tmp_path,"source_folder")
+    yaml_output_folder = os.path.join(tmp_path,"yaml_output_folder")
+    package_info_2.path = Source(
+        source_folder = source_folder, yaml_output_folder = yaml_output_folder, package_name = 'azure-core-tracing-opencensus'
+    )
+    exclude_path = package_info_2.get_exluded_command()
+    expected_exclude_path = [
+        "build/*",
+        "setup.py",
+        "azure/__init__.py",
+        "azure/core/__init__.py",
+        "azure/core/tracing/__init__.py",
+        'azure/core/tracing/ext/__init__.py'
+    ]
+    def form_exclude_path(raletive_path):
+        return os.path.join(source_folder, raletive_path)
+    assert exclude_path == [form_exclude_path(path) for path in expected_exclude_path]

py2docfx/docfx_yaml/build_finished.py

@@ -26,9 +26,37 @@ scientific_notation_regex = re.compile(r'^[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)$
 def string_representer(dumper, data):
     return dumper.represent_scalar(u"tag:yaml.org,2002:str", data,
                                    style="'" if (scientific_notation_regex.match(data)) else None)
-
 yml.add_representer(str, string_representer)
 
+def insert_node_to_toc_tree(toc_yaml, uid, project_name, toc_node_map):
+    # Build nested TOC
+    parent_level = uid
+    cur_node = None
+
+    # Try all ancestors azure.core.class1 -> azure.core -> azure
+    while parent_level.count('.') >= 1:
+        parent_level = '.'.join(parent_level.split('.')[:-1])
+        found_node = toc_node_map[parent_level] if parent_level in toc_node_map else None
+        if found_node:
+            # If ancestor already in current TOC, insert to its items
+            name = uid.split('.')[-1] if '.' in uid and project_name != uid else uid
+            cur_node = {'name': name, 'uid': uid}
+            if 'uid' in found_node:
+                # Only leaf nodes should have uid
+                found_node.pop('uid', 'No uid found')
+            # Subpackages should have its Overview page
+            found_node.setdefault('items', [{'name': 'Overview', 'uid': parent_level}]).append(cur_node)
+            break
+    
+    # uid is representing a package in TOC as root node
+    if cur_node is None:
+        # if uid doesn't contain '.', the name needn't to simplify
+        cur_node = {'name': uid}
+        toc_yaml.append(cur_node)
+
+    # insert to uid-toc map
+    toc_node_map[uid] = cur_node
+
 def merge_params(arg_params, doc_params):
     merged_params = deepcopy(doc_params)
     # merge arg_params into merged_params
@@ -55,10 +83,10 @@ def remove_params_without_id(params):
     return new_params
 
 def add_isrequired_if_needed(obj, key: str):
-        if key in obj['syntax'] and obj['type'] in ['class', 'function', 'method']:
-            for args in obj['syntax'][key]:
-                if 'isRequired' not in args and 'defaultValue' not in args:
-                    args['isRequired'] = True
+    if key in obj['syntax'] and obj['type'] in ['class', 'function', 'method']:
+        for args in obj['syntax'][key]:
+            if 'isRequired' not in args and 'defaultValue' not in args:
+                args['isRequired'] = True
 
 def get_merged_params(obj, info_field_data, key: str):
     merged_params = []
@@ -68,7 +96,7 @@ def get_merged_params(obj, info_field_data, key: str):
             key, [])
         if arg_params and doc_params:
             if len(arg_params) - len(doc_params) > 0:
-                print("Documented params don't match size of params:"" {}".format(obj['uid']))   # lgtm [py/clear-text-logging-sensitive-data]
+                print(f'Documented params don\'t match size of params:{obj["uid"]}')   # lgtm [py/clear-text-logging-sensitive-data]
             doc_params = remove_params_without_id(doc_params)
             merged_params = merge_params(arg_params, doc_params)
     else:
@@ -81,7 +109,7 @@ def raise_up_fields(obj):
     if 'summary' in obj['syntax'] and obj['syntax']['summary']:
         obj['summary'] = obj['syntax'].pop(
             'summary').strip(" \n\r\r")
-
+    
     # Raise up remarks
     if 'remarks' in obj['syntax'] and obj['syntax']['remarks']:
         obj['remarks'] = obj['syntax'].pop('remarks')
@@ -148,35 +176,6 @@ def merge_data(obj, info_field_data, yaml_data):
     # Revert `type` for other objects to use
     info_field_data[obj['uid']]['type'] = obj['type']
 
-def find_node_in_toc_tree(toc_yaml, to_add_node):
-    for module in toc_yaml:
-        if module['name'] == to_add_node:
-            return module
-
-        if 'items' in module:
-            items = module['items']
-            found_module = find_node_in_toc_tree(items, to_add_node)
-            if found_module != None:
-                return found_module
-
-    return None
-
-def build_nested_toc(toc_yaml, uid):
-    # Build nested TOC
-    if uid.count('.') >= 1:
-        parent_level = '.'.join(uid.split('.')[:-1])
-        found_node = find_node_in_toc_tree(toc_yaml, parent_level)
-
-        if found_node:
-            found_node.pop('uid', 'No uid found')
-            found_node.setdefault('items', [{'name': 'Overview', 'uid': parent_level}]).append(
-                {'name': uid, 'uid': uid})
-        else:
-            toc_yaml.append({'name': uid, 'uid': uid})
-
-    else:
-        toc_yaml.append({'name': uid, 'uid': uid})
-
 def build_finished(app, exception):
     """
     Output YAML on the file system.
@@ -207,6 +206,8 @@ def build_finished(app, exception):
     ))
 
     ensuredir(normalized_outdir)
+    project_name = app.config.project.replace('-','.')
+    toc_node_map = {}
 
     def filter_out_self_from_args(obj):
         arg_params = obj.get('syntax', {}).get('parameters', [])
@@ -260,30 +261,13 @@ def build_finished(app, exception):
                 if (obj['type'] == 'class' and obj['inheritance']):
                     convert_class_to_enum_if_needed(obj)
 
-            build_nested_toc(toc_yaml, uid)
-
-    index_children = []
-    index_references = []
-
-    def form_index_references_and_children(yaml_data, index_children, index_references):
-        if yaml_data[0].get('type', None) in ['package', 'module']:
-            index_children.append(yaml_data[0].get('fullName', ''))
-            index_references.append({
-                'uid': yaml_data[0].get('fullName', ''),
-                'name': yaml_data[0].get('fullName', ''),
-                'fullname': yaml_data[0].get('fullName', ''),
-                'isExternal': False
-            })
+            insert_node_to_toc_tree(toc_yaml, uid, project_name, toc_node_map)
 
     for data_set in (app.env.docfx_yaml_packages,
                      app.env.docfx_yaml_modules,
                      app.env.docfx_yaml_classes,
                      app.env.docfx_yaml_functions):  # noqa
-
         for uid, yaml_data in iter(sorted(data_set.items())):
-
-            form_index_references_and_children(yaml_data, index_children, index_references)
-
             # Output file
             if uid.lower() in file_name_set:
                 filename = uid + "(%s)" % app.env.docfx_info_uid_types[uid]
@@ -291,7 +275,6 @@ def build_finished(app, exception):
                 filename = uid
             out_file = os.path.join(normalized_outdir, '%s.yml' % filename)
             ensuredir(os.path.dirname(out_file))
-            new_object = {}
 
             transformed_obj = None
             if yaml_data[0]['type'] == 'package':
@@ -310,12 +293,13 @@ def build_finished(app, exception):
                 mime = "PythonModule"
 
             if transformed_obj == None:
-                print("Unknown yml: " + yamlfile_path)
+                print(f"Unknown yml, uid is: {uid}")
             else:
                 # save file
                 common.write_yaml(transformed_obj, out_file, mime)
                 file_name_set.add(filename)
 
+    # Write TOC, the toc should include at least 1 
     if len(toc_yaml) == 0:
         raise RuntimeError("No documentation for this module.")
 
@@ -323,31 +307,7 @@ def build_finished(app, exception):
     with open(toc_file, 'w') as writable:
         writable.write(
             dump(
-                [{
-                    'name': app.config.project,
-                    'items': [{'name': 'Overview', 'uid': 'project-' + app.config.project}] + toc_yaml
-                }],
+                toc_yaml,
                 default_flow_style=False,
             )
         )
-
-    index_file = os.path.join(normalized_outdir, 'index.yml')
-
-    index_obj = [{
-        'uid': 'project-' + app.config.project,
-        'name': app.config.project,
-        'fullName': app.config.project,
-        'langs': ['python'],
-        'type': 'package',
-        'kind': 'distribution',
-        'summary': '',
-        'children': index_children
-    }]
-    transformed_obj = convert_package(index_obj, app.env.docfx_info_uid_types)
-    mime = "PythonPackage"
-    if transformed_obj == None:
-        print("Unknown yml: " + yamlfile_path)
-    else:
-        # save file
-        common.write_yaml(transformed_obj, index_file, mime)
-        file_name_set.add(filename)

py2docfx/docfx_yaml/tests/test_build_finished.py

@@ -1,8 +1,9 @@
+import os
 import pytest
-
+import yaml
 from translator import translator
 from build_finished import build_finished, merge_data
-
+from docfx_yaml.settings import API_ROOT
 from .utils.test_utils import prepare_app_envs,load_rst_transform_to_doctree
 
 @pytest.mark.sphinx('yaml', testroot='build-finished')
@@ -130,4 +131,52 @@ def test_merge_data_added_attribute():
     # Assert the results
     assert 'added_attribute' not in obj['syntax']
     assert len(yaml_data) == 1
-    assert yaml_data[0]['uid'] == 'attr1'
+    assert yaml_data[0]['uid'] == 'attr1'
+
+
+@pytest.mark.sphinx('yaml', testroot='build-finished')
+def test_build_finished_check_toc(tmp_path, app):
+    app.builder.outdir = tmp_path
+    app.config.project = 'azure-durable-functions'
+    app.env.docfx_yaml_packages = {
+        'azure.durable_functions':[{'uid':'azure.durable_functions','type':'package'}], 
+        'azure.durable_functions.models':[{'uid':'azure.durable_functions.models','type':'package'}], 
+        }
+    app.env.docfx_yaml_modules = {
+        'azure.durable_functions.constants':[{'uid':'azure.durable_functions.constants','type':'module'}],
+        'azure.durable_functions.models.DurableEntityContext':[{'uid':'azure.durable_functions.models.DurableEntityContext','type':'module'}],
+        }
+    app.env.docfx_yaml_classes = {'azure.durable_functions.Blueprint':[{'uid':'azure.durable_functions.Blueprint','type':'class', 'inheritance':[]}]}
+
+    # Act
+    build_finished(app, None)
+
+    # Assert after build_finished
+    toc = None
+    with open(os.path.join(tmp_path, API_ROOT, 'toc.yml'), 'r', encoding='utf-8') as file:
+        toc = yaml.safe_load(file)
+    
+    assert 1 == len(toc)
+    assert 'azure.durable_functions' == toc[0]['name']
+    assert 'uid' not in toc[0] # root packages shouldn't have uid
+    
+    assert 4 == len(toc[0]['items'])
+    assert 'Overview' == toc[0]['items'][0]['name']
+    assert 'azure.durable_functions' == toc[0]['items'][0]['uid']
+    
+    assert 'models' == toc[0]['items'][1]['name']
+    assert 'uid' not in toc[0]['items'][1]
+    assert 2 == len(toc[0]['items'][1]['items'])
+    assert 'Overview' == toc[0]['items'][1]['items'][0]['name']
+    assert 'azure.durable_functions.models' == toc[0]['items'][1]['items'][0]['uid']
+    assert 'DurableEntityContext' == toc[0]['items'][1]['items'][1]['name']
+    assert 'azure.durable_functions.models.DurableEntityContext' == toc[0]['items'][1]['items'][1]['uid']
+
+    assert 'constants' == toc[0]['items'][2]['name']
+    assert 'azure.durable_functions.constants' == toc[0]['items'][2]['uid']
+
+    assert 'Blueprint' == toc[0]['items'][3]['name']
+    assert 'azure.durable_functions.Blueprint' == toc[0]['items'][3]['uid']
+
+
+    1

py2docfx/docfx_yaml/writer.py

@@ -31,7 +31,6 @@ from sphinx import addnodes
 from sphinx.locale import admonitionlabels
 
 from nodes import remarks
-import write_utils
 
 class bcolors:
     HEADER = '\033[95m'
@@ -1059,14 +1058,10 @@ 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.2.dev1649201.dist-info → py2docfx-0.1.2.dev1676273.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.2.dev1649201
+Version: 0.1.2.dev1676273
 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.2.dev1649201.dist-info → py2docfx-0.1.2.dev1676273.dist-info}/RECORD

@@ -8,7 +8,8 @@ py2docfx/convert_prepare/get_source.py,sha256=Rl6WYWpkalAWmc-02ZLb9zXxrHNDFaOoFT
 py2docfx/convert_prepare/git.py,sha256=xGJp2nDWLfVljrxyPnFKPoLIqmBh6by-QdITogIuxi0,5893
 py2docfx/convert_prepare/install_package.py,sha256=hATmgazcSX7k2n4jQXh9sQMyNUc1k1YqHv5K5UMALq4,262
 py2docfx/convert_prepare/pack.py,sha256=vZS67_GzEhUmZWHU1dxm8gnWyRBs-kB6-KjX1d_FdOU,1260
-py2docfx/convert_prepare/package_info.py,sha256=RCN3enfwXeU_9H8xBHLalvbhUrGxMtmlX0F9omGoPjU,6856
+py2docfx/convert_prepare/package_info.py,sha256=V-xasck6ZfqJdUjlGHtkC1iE-DCBDAMK8Z0q-NronkE,7254
+py2docfx/convert_prepare/package_info_extra_settings.py,sha256=pjZ2-DAOljBrx3L9N6sB5QohntFRa0uCCRiPEBXTvQg,1299
 py2docfx/convert_prepare/params.py,sha256=PXMB8pLtb4XbfI322avA47q0AO-TyBE6kZf7FU8I6v4,1771
 py2docfx/convert_prepare/paths.py,sha256=964RX81Qf__rzXgEATfqBNFCKTYVjLt9J7WCz2TnNdc,485
 py2docfx/convert_prepare/pip_utils.py,sha256=W8PJQQSZXUW7W_mdBxaK6KRuxMEskO1-Hw6hjRazqTY,1127
@@ -22,10 +23,10 @@ py2docfx/convert_prepare/post_process/merge_toc.py,sha256=coyae54OB1nGcCkxz9oAu-
 py2docfx/convert_prepare/subpackage_merge/merge_root_package.py,sha256=uK96qL2asuSfo_3SZaoP8XZaUvjf5mNkr17JNbZR4Lg,1026
 py2docfx/convert_prepare/subpackage_merge/merge_toc.py,sha256=nkVqe8R0m8D6cyTYV7aIpMDXorvn4-LXfU_vIK_hJBg,1706
 py2docfx/convert_prepare/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-py2docfx/convert_prepare/tests/test_generate_document.py,sha256=BKw8pMSsygLnv6bETlA2MIVarECzfWoNo4JglxHb-T4,2480
+py2docfx/convert_prepare/tests/test_generate_document.py,sha256=hOAtib9pTFaZCS8QbYS6Dhz0hNGESDHPXumRIuIWp4Y,2415
 py2docfx/convert_prepare/tests/test_get_source.py,sha256=c22JfobgbEbWWiNzBNYpZm2yDfo5LwBioUuRwft9WZE,5858
 py2docfx/convert_prepare/tests/test_pack.py,sha256=46JWMNzknIptDVs7D3CuxcmqBr_OKMmaw1br9H7wqco,4134
-py2docfx/convert_prepare/tests/test_package_info.py,sha256=L2ax9dItnz5QNSsSjSjEcaS6UPZxiq3MwysBB1FdJxI,2262
+py2docfx/convert_prepare/tests/test_package_info.py,sha256=hdNpAH9hlLF-cX9sKAu3cmiCtphX4USy9G_gWI_iaHo,3883
 py2docfx/convert_prepare/tests/test_params.py,sha256=p9DaGveocMBRih02KjpudJZE752neFBTLzOFbS47izQ,2036
 py2docfx/convert_prepare/tests/test_post_process_merge_toc.py,sha256=YKOcn4_lf4syGsAvJ9BqpdUUc3SLfK4TiOX1lpXJT_Y,885
 py2docfx/convert_prepare/tests/test_source.py,sha256=LNFZtvjz6QhVLOxatjWokYCCcoSm0bhTikMF9KoTPIE,2025
@@ -52,7 +53,7 @@ py2docfx/convert_prepare/tests/data/subpackage/azure-mgmt-containerservice/azure
 py2docfx/convert_prepare/tests/data/subpackage/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_03_31/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/tests/data/subpackage/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_03_31/models.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/docfx_yaml/__init__.py,sha256=KCEizAXv-SXtrYhvFfLHdBWDhz51AA9uagaeTL-Itpo,100
-py2docfx/docfx_yaml/build_finished.py,sha256=kJemkgnh9NIzn4E8jcAIaP7vb7wcHzdLl7yWUjoZbi8,14218
+py2docfx/docfx_yaml/build_finished.py,sha256=yMA2Q3tuaXch6xzSe12ehpEIFs0r0S-M79w_xueCcsk,13115
 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=boKDaxnXbnLxja62UFXi3eChGDB_WBW6ouUUJgOhdpE,2098
@@ -68,12 +69,11 @@ 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/write_utils.py,sha256=q5qoYWw6GVDV8a3E8IxcSLWnN9sAer42VFRgadHBkgk,305
-py2docfx/docfx_yaml/writer.py,sha256=gyGe9GsNpCithBZh1C3_WENNvssqIARPpU37frDY9jk,34919
+py2docfx/docfx_yaml/writer.py,sha256=0ZqyVGDHa4Cr3NsuOPRf4pGUStl6g6IBxpSgIZeDT9I,34683
 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
-py2docfx/docfx_yaml/tests/test_build_finished.py,sha256=ShCRhIHGu2IUaM6iWsC0w9i_qmdc_kadPE3oPRBBZbQ,4720
+py2docfx/docfx_yaml/tests/test_build_finished.py,sha256=x1aaOzUJxQkmwEaVgKxtC7kvVPeO7cCgFNDQq2GApxQ,6979
 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
@@ -86,7 +86,6 @@ 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=jy7XZk-Fef-8olg9Tud9odzFsKPo2LwJF7zvQUNzwwU,2998
 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
@@ -119,10 +118,8 @@ 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.2.dev1649201.dist-info/METADATA,sha256=5LXsrg32UsizIoEJePD1PLiNshj9XDC0S3xWNrs-QE0,601
-py2docfx-0.1.2.dev1649201.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-py2docfx-0.1.2.dev1649201.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.2.dev1649201.dist-info/RECORD,,
+py2docfx-0.1.2.dev1676273.dist-info/METADATA,sha256=8qvz-lL095C2wMLVfhz8FqPdtlXKQ0a5yhpKafMUpiw,601
+py2docfx-0.1.2.dev1676273.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+py2docfx-0.1.2.dev1676273.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.2.dev1676273.dist-info/RECORD,,

{py2docfx-0.1.2.dev1649201.dist-info → py2docfx-0.1.2.dev1676273.dist-info}/WHEEL

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

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

@@ -1,43 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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

@@ -1,57 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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