py2docfx 0.1.1.dev1634739__py3-none-any.whl → 0.1.2.dev1669302__py3-none-any.whl

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -51,4 +51,5 @@ 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/docfx_yaml/build_finished.py

@@ -26,36 +26,8 @@ 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
+yml.add_representer(str, string_representer)
 
 def merge_params(arg_params, doc_params):
     merged_params = deepcopy(doc_params)
@@ -83,10 +55,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 = []
@@ -96,7 +68,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(f'Documented params don\'t match size of params:{obj["uid"]}')   # lgtm [py/clear-text-logging-sensitive-data]
+                print("Documented params don't match size of params:"" {}".format(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:
@@ -109,7 +81,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')
@@ -176,6 +148,35 @@ 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.
@@ -206,8 +207,6 @@ 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', [])
@@ -261,13 +260,30 @@ def build_finished(app, exception):
                 if (obj['type'] == 'class' and obj['inheritance']):
                     convert_class_to_enum_if_needed(obj)
 
-            insert_node_to_toc_tree(toc_yaml, uid, project_name, toc_node_map)
+            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
+            })
 
     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]
@@ -275,6 +291,7 @@ 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':
@@ -293,13 +310,12 @@ def build_finished(app, exception):
                 mime = "PythonModule"
 
             if transformed_obj == None:
-                print(f"Unknown yml, uid is: {uid}")
+                print("Unknown yml: " + yamlfile_path)
             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.")
 
@@ -307,7 +323,31 @@ def build_finished(app, exception):
     with open(toc_file, 'w') as writable:
         writable.write(
             dump(
-                toc_yaml,
+                [{
+                    'name': app.config.project,
+                    'items': [{'name': 'Overview', 'uid': 'project-' + app.config.project}] + 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-0.1.1.dev1634739.dist-info → py2docfx-0.1.2.dev1669302.dist-info}/METADATA

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

@@ -22,7 +22,7 @@ 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=hOAtib9pTFaZCS8QbYS6Dhz0hNGESDHPXumRIuIWp4Y,2415
+py2docfx/convert_prepare/tests/test_generate_document.py,sha256=BKw8pMSsygLnv6bETlA2MIVarECzfWoNo4JglxHb-T4,2480
 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
@@ -52,7 +52,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=yMA2Q3tuaXch6xzSe12ehpEIFs0r0S-M79w_xueCcsk,13115
+py2docfx/docfx_yaml/build_finished.py,sha256=kJemkgnh9NIzn4E8jcAIaP7vb7wcHzdLl7yWUjoZbi8,14218
 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
@@ -118,7 +118,7 @@ py2docfx/docfx_yaml/tests/roots/test-writer-table/conf.py,sha256=avcbnIOV2mlGQwh
 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/utils/test_utils.py,sha256=d0OYSUQ6NyoZx5mlLdNGGNhiNmmQhjVT4hQ6jY3VE_M,3383
-py2docfx-0.1.1.dev1634739.dist-info/METADATA,sha256=-nfp6HMtH1bJnfA0g0LO-xxy40caY8Rjnif_5nK4RjM,601
-py2docfx-0.1.1.dev1634739.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-py2docfx-0.1.1.dev1634739.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.1.dev1634739.dist-info/RECORD,,
+py2docfx-0.1.2.dev1669302.dist-info/METADATA,sha256=iivYGhk17bJTOQ7f45BXY_Ey5MbEkzUvainKAoKAAqI,601
+py2docfx-0.1.2.dev1669302.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+py2docfx-0.1.2.dev1669302.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.2.dev1669302.dist-info/RECORD,,

{py2docfx-0.1.1.dev1634739.dist-info → py2docfx-0.1.2.dev1669302.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