py2docfx 0.1.4rc1691271__py3-none-any.whl → 0.1.5__py3-none-any.whl

py2docfx/docfx_yaml/build_finished.py

@@ -28,11 +28,11 @@ def string_representer(dumper, 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):
+def insert_node_to_toc_tree_return_is_root_package(toc_yaml, uid, project_name, toc_node_map):
     # Build nested TOC
     parent_level = uid
     cur_node = None
-
+    is_root = False
     # Try all ancestors azure.core.class1 -> azure.core -> azure
     while parent_level.count('.') >= 1:
         parent_level = '.'.join(parent_level.split('.')[:-1])
@@ -53,9 +53,11 @@ def insert_node_to_toc_tree(toc_yaml, uid, project_name, toc_node_map):
         # if uid doesn't contain '.', the name needn't to simplify
         cur_node = {'name': uid}
         toc_yaml.append(cur_node)
+        is_root = True
 
     # insert to uid-toc map
     toc_node_map[uid] = cur_node
+    return is_root
 
 def merge_params(arg_params, doc_params):
     merged_params = deepcopy(doc_params)
@@ -239,6 +241,7 @@ def build_finished(app, exception):
 
             references = []
             # Merge module data with class data
+            package_obj = None
             for obj in yaml_data:
                 obj = filter_out_self_from_args(obj)
 
@@ -257,11 +260,14 @@ def build_finished(app, exception):
                 # To distinguish distribution package and import package
                 if obj.get('type', '') == 'package' and obj.get('kind', '') != 'distribution':
                     obj['kind'] = 'import'
+                    package_obj = obj
 
                 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)
+            is_root = insert_node_to_toc_tree_return_is_root_package(toc_yaml, uid, project_name, toc_node_map)
+            if is_root and package_obj is not None:
+                package_obj['kind'] = 'rootImport' # API Browser only list root packages for ApiList feature
 
     for data_set in (app.env.docfx_yaml_packages,
                      app.env.docfx_yaml_modules,

py2docfx/docfx_yaml/tests/test_build_finished.py

@@ -178,5 +178,30 @@ def test_build_finished_check_toc(tmp_path, app):
     assert 'Blueprint' == toc[0]['items'][3]['name']
     assert 'azure.durable_functions.Blueprint' == toc[0]['items'][3]['uid']
 
+@pytest.mark.sphinx('yaml', testroot='build-finished')
+def test_build_finished_check_root_package_type(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':[]}]}
 
-    1
+    # Act
+    build_finished(app, None)
+
+    # Assert after build_finished
+    rootPackageYaml = None
+    with open(os.path.join(tmp_path, API_ROOT, 'azure.durable_functions.yml'), 'r', encoding='utf-8') as file:
+        rootPackageYaml = yaml.safe_load(file)
+    assert 'rootImport' == rootPackageYaml['type']
+
+    subPackageYaml = None
+    with open(os.path.join(tmp_path, API_ROOT, 'azure.durable_functions.models.yml'), 'r', encoding='utf-8') as file:
+        subPackageYaml = yaml.safe_load(file)
+    assert 'import' == subPackageYaml['type']

{py2docfx-0.1.4rc1691271.dist-info → py2docfx-0.1.5.dist-info}/METADATA

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

@@ -53,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=yMA2Q3tuaXch6xzSe12ehpEIFs0r0S-M79w_xueCcsk,13115
+py2docfx/docfx_yaml/build_finished.py,sha256=i7oPa_zdWplwiVUNUqwAArM7gTskkWeeflv03N_i6Bg,13468
 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
@@ -74,7 +74,7 @@ py2docfx/docfx_yaml/writer.py,sha256=BQ02TshJM7O53_n07i_DJ-WtI7PYNyBJ2OLzivq4iiA
 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=x1aaOzUJxQkmwEaVgKxtC7kvVPeO7cCgFNDQq2GApxQ,6979
+py2docfx/docfx_yaml/tests/test_build_finished.py,sha256=PSyWuY_XWmNeSjQl4kBwHUWpEhQHuEXQCZPWtFZ7vb4,8433
 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
@@ -123,7 +123,7 @@ py2docfx/docfx_yaml/tests/roots/test-writer-uri/conf.py,sha256=avcbnIOV2mlGQwhMQ
 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.4rc1691271.dist-info/METADATA,sha256=otIiFyIP9uMBws8g2zMsJoXnEnybXyAUksJL6CSaOjQ,599
-py2docfx-0.1.4rc1691271.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-py2docfx-0.1.4rc1691271.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.4rc1691271.dist-info/RECORD,,
+py2docfx-0.1.5.dist-info/METADATA,sha256=3AtHO_N48RVvi6lYOmWLDq1ckMXoOw3eSLHT5YlaZ3c,590
+py2docfx-0.1.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+py2docfx-0.1.5.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.5.dist-info/RECORD,,