py2docfx 0.1.1.dev1622985__py3-none-any.whl → 0.1.1.dev1626976__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

@@ -32,24 +32,18 @@ def build_finished(app, exception):
     """
     Output YAML on the file system.
     """
-    def insert_node_to_toc_tree(toc_yaml, uid, project_name, toc_node_map):
-        name = uid.split('.')[-1] if '.' in uid and uid.startswith(project_name) and project_name != uid else uid
-        cur_node = {'name': name, 'uid': uid}
-
-        # Build nested TOC
-        if uid.count('.') >= 1:
-            parent_level = '.'.join(uid.split('.')[:-1])
-            found_node = toc_node_map[parent_level] if parent_level in toc_node_map else None
-            if found_node:
-                if 'uid' in found_node:
-                    found_node.pop('uid', 'No uid found')
-                found_node.setdefault('items', [{'name': 'Overview', 'uid': parent_level}]).append(cur_node)
-            else:
-                toc_yaml.append(cur_node)
-        else:
-            # if uid doesn't contain '.', the name needn't to simplify
-            toc_yaml.append(cur_node)
-        toc_node_map[uid] = cur_node
+    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 convert_class_to_enum_if_needed(obj):
         if (obj.get('inheritance'), None):
@@ -100,8 +94,7 @@ def build_finished(app, exception):
         API_ROOT
     ))
     ensuredir(normalized_outdir)
-    project_name = app.config.project.replace('-','.')
-    toc_node_map = {}
+
     toc_yaml = []
     # Used to record filenames dumped to avoid confliction
     # caused by Windows case insensitive file system
@@ -110,8 +103,8 @@ def build_finished(app, exception):
     # Order matters here, we need modules before lower level classes,
     # so that we can make sure to inject the TOC properly
     # put app.env.docfx_yaml_packages after app.env.docfx_yaml_modules to keep same TOC items order
-    for data_set in (app.env.docfx_yaml_packages,
-                     app.env.docfx_yaml_modules,
+    for data_set in (app.env.docfx_yaml_modules,
+                     app.env.docfx_yaml_packages,
                      app.env.docfx_yaml_classes,
                      app.env.docfx_yaml_functions):  # noqa
 
@@ -219,7 +212,20 @@ 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
+            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})
 
     for data_set in (app.env.docfx_yaml_packages,
                      app.env.docfx_yaml_modules,
@@ -266,8 +272,41 @@ 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_children = []
+    index_references = []
+    for item in toc_yaml:
+        index_children.append(item.get('name', ''))
+        index_references.append({
+            'uid': item.get('name', ''),
+            'name': item.get('name', ''),
+            'fullname': item.get('name', ''),
+            'isExternal': False
+        })
+
+    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.dev1622985.dist-info → py2docfx-0.1.1.dev1626976.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.1.dev1622985
+Version: 0.1.1.dev1626976
 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.dev1622985.dist-info → py2docfx-0.1.1.dev1626976.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=4gAjTchmTBNb0-g0i06rRVUjNbFXIL55knH3v5u6gWo,12823
+py2docfx/docfx_yaml/build_finished.py,sha256=jf8--IvekegnTs6Qx9H31TlDNZA6E5yPWaInmHH9QbA,13996
 py2docfx/docfx_yaml/build_init.py,sha256=lAw-fnBVQbySfZ7Sut_NpFQUjnqLOmnGQrTBBH2RXcg,1860
 py2docfx/docfx_yaml/common.py,sha256=Tl6OPSIcvPjFw1AvWt5Mun8pQr9NtUGQnk4zh474Py0,6316
 py2docfx/docfx_yaml/convert_class.py,sha256=boKDaxnXbnLxja62UFXi3eChGDB_WBW6ouUUJgOhdpE,2098
@@ -112,7 +112,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.dev1622985.dist-info/METADATA,sha256=IBip8SicKCdI9fIb5WnLxZ05mrbWoRZQE538ci4j82E,601
-py2docfx-0.1.1.dev1622985.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-py2docfx-0.1.1.dev1622985.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.1.dev1622985.dist-info/RECORD,,
+py2docfx-0.1.1.dev1626976.dist-info/METADATA,sha256=e91GJa9tJNOi4pWlJYftdnPOm-YLGHUHukSdjnmwmsE,601
+py2docfx-0.1.1.dev1626976.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+py2docfx-0.1.1.dev1626976.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.1.dev1626976.dist-info/RECORD,,