py2docfx 0.1.0.dev1465108__py3-none-any.whl → 0.1.0.dev1465352__py3-none-any.whl

py2docfx/__main__.py

@@ -12,7 +12,6 @@ from py2docfx.convert_prepare.package_info import PackageInfo
 
 print("Adding yaml extension to path")
 sys.path.insert(0, os.path.join(os.path.dirname(os.path.abspath(__file__)),'docfx_yaml'))
-DOC_FOLDER_NAME = "docs-ref-autogen"
 os.chdir(PACKAGE_ROOT)
 
 def get_parser() -> argparse.ArgumentParser:
@@ -249,11 +248,10 @@ def prepare_out_dir(output_root: str | os.PathLike) -> os.PathLike | None:
                 if len(os.listdir(output_root)) > 0:
                     raise ValueError(f"""output-root-folder isn't empty,
                                     output-root-folder value: {output_root}""")
+                return output_root
         else:
             os.makedirs(output_root)
-            output_doc_folder = os.path.join(output_root, DOC_FOLDER_NAME)
-            os.makedirs(output_doc_folder)
-            return output_doc_folder
+            return output_root
     else:
         return None
 

py2docfx/convert_prepare/package_info.py

@@ -154,4 +154,11 @@ class PackageInfo:
                         for path in self.exclude_path
                     ]
                 )
+            # exclude root package __init__.py, prevent generating azure.yml
+            current_parent_packages = ''
+            package_name_segs = [seg for seg in self.name.split('-') if seg]
+            for idx, package_seg in enumerate(package_name_segs):
+                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'))
         return exclude_path

py2docfx/convert_prepare/sphinx_caller.py

@@ -1,4 +1,5 @@
 import os
+import sys
 from sphinx.application import Sphinx
 import sphinx.ext.apidoc as apidoc
 import sphinx.cmd.build
@@ -74,8 +75,10 @@ def run_converter(rst_path, out_path, conf_path = None):
         app.build(force_all=True)
     else:
         sphinx_build_path = sphinx.cmd.build.__file__
+        if not sys.executable:
+            raise ValueError("Can't get the executable binary for the Python interpreter.")
         sphinx_param = [
-            'python', sphinx_build_path,
+            sys.executable, sphinx_build_path,
             rst_path,
             outdir,
             '-c', conf_path or rst_path,

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -13,27 +13,26 @@ def test_generate_document(tmp_path):
     Test the generate_document function.
     """
     # init test case
-    source_code_path = "convert_prepare\\tests\\data\\generate_document\\"
+    source_code_path = "convert_prepare\\tests\\data\\generate_document"
     output_root = os.path.join(tmp_path, "output")
     shutil.copytree(source_code_path, os.path.join(tmp_path, "source\\0"))
     package = PackageInfo()
-    package.name = "dummy_source_code"
+    package.name = "azure-dummy-sourcecode"
     package.exclude_path = ["test*", "example*", "sample*", "doc*"]
     package.install_type = PackageInfo.InstallType.PYPI
     package.version = None
     package.build_in_subpackage = False
     package.extra_index_url = None
     package.prefer_source_distribution = False
-    source_folder = os.path.join(tmp_path, "source\\0")
+    source_folder = os.path.join(tmp_path, "source\\0\\azure-dummy-sourcecode")
     yaml_output_folder = os.path.join(tmp_path, "yaml_output")
     package.path = Source(
         source_folder=source_folder, yaml_output_folder=yaml_output_folder, package_name=package.name
     )
 
     # add dummy code to python sys path to simulate installation
-    dummy_path = os.path.join(tmp_path, "source\\0")
-    os.environ["PYTHONPATH"] = os.path.abspath(dummy_path)
-    sys.path.insert(0, os.path.abspath(dummy_path))
+    os.environ["PYTHONPATH"] = os.path.abspath(source_folder)
+    sys.path.insert(0, os.path.abspath(source_folder))
 
     # add docfx_yaml to python sys path for sphinx build to import
     sys.path.insert(1, os.path.abspath("docfx_yaml"))
@@ -44,10 +43,13 @@ def test_generate_document(tmp_path):
     #assert the result
     yaml_path = os.path.join(yaml_output_folder, "_build\\docfx_yaml")
     assert os.path.exists(yaml_path)
-    assert os.path.exists(os.path.join(yaml_path, "dummy_source_code.foo.foo.yml"))
-    assert os.path.exists(os.path.join(yaml_path, "dummy_source_code.boo.boo.yml"))
-    assert os.path.exists(os.path.join(yaml_path, "dummy_source_code.foo.foo.Foo.yml"))
-    assert os.path.exists(os.path.join(yaml_path, "dummy_source_code.boo.boo.Boo.yml"))
+    assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.foo.foo.yml"))
+    assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.boo.boo.yml"))
+    assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.foo.foo.Foo.yml"))
+    assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.boo.boo.Boo.yml"))
+    assert os.path.exists(os.path.join(yaml_path, "azure.dummy.sourcecode.yml"))
+    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

@@ -19,7 +19,7 @@ package_info_1 = PackageInfo.parse_from(test_dict["packages"][1], False)
 
 def test_parse_from():
     assert package_info_0.exclude_path == ["test*", "example*", "sample*", "doc*"]
-    assert package_info_0.name == "mltable"
+    assert package_info_0.name == "azure-mltable-py2docfxtest"
     assert package_info_0.install_type.name == "PYPI"
 
 def test_get_combined_name_version():
@@ -28,7 +28,7 @@ def test_get_combined_name_version():
 
 def test_intall_command():
     install_command = package_info_0.get_install_command()
-    assert install_command[0] == "mltable"
+    assert install_command[0] == "azure-mltable-py2docfxtest"
     assert install_command[1] == ["--upgrade"]
 
     install_command = package_info_1.get_install_command()
@@ -39,7 +39,7 @@ 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 = "dummy"
+        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 = [
@@ -49,8 +49,9 @@ def test_get_exclude_command(tmp_path):
         "example*",
         "sample*",
         "doc*",
+        "azure/__init__.py",
+        "azure/mltable/__init__.py"
     ]
     def form_exclude_path(raletive_path):
         return os.path.join(source_folder, raletive_path)
-    expected_exclude_path = map(form_exclude_path, expected_exclude_path)
-    assert exclude_path == list(expected_exclude_path)
+    assert exclude_path == [form_exclude_path(path) for path in expected_exclude_path]

py2docfx/convert_prepare/tests/test_params.py

@@ -12,7 +12,7 @@ def extract_package_infos(iterator):
 
 def package_info_assert(package_info_list, required_package_info_list):
     package = package_info_list[0]
-    assert package.name == "mltable"
+    assert package.name == "azure-mltable-py2docfxtest"
     assert package.install_type.name == "PYPI"
     assert package.exclude_path == ["test*", "example*", "sample*", "doc*"]
 

py2docfx/convert_prepare/tests/test_sphinx_caller.py

@@ -18,7 +18,7 @@ def init_paths(tmp_path):
     package_info.exclude_path = ["testcode\\exclude\\*"]
     package_info.path = Source(source_folder=destination, yaml_output_folder=rst_path, package_name="testcode")
     package_info.build_in_subpackage = False
-
+    package_info.name = 'testcode'
     return rst_path, destination
 
 
@@ -28,7 +28,6 @@ def test_run_apidoc(tmp_path):
 
     # List all files under rst_path
     rst_list = os.listdir(rst_path)
-    assert "testcode.rst" in rst_list
     assert "testcode.fakemodule.rst" in rst_list
     assert "testcode.exclude.rst" not in rst_list
 
@@ -51,7 +50,6 @@ def test_run_converter(tmp_path):
 
     if os.path.exists(out_path):
         yaml_list = os.listdir(os.path.join(out_path, "docfx_yaml"))
-        assert "testcode.yml" in yaml_list
         assert "testcode.fakemodule.test_code.yml" in yaml_list
         assert "testcode.fakemodule.test_code.testClass.yml" in yaml_list
         assert "toc.yml" in yaml_list

{py2docfx-0.1.0.dev1465108.dist-info → py2docfx-0.1.0.dev1465352.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.0.dev1465108
+Version: 0.1.0.dev1465352
 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.0.dev1465108.dist-info → py2docfx-0.1.0.dev1465352.dist-info}/RECORD

@@ -1,5 +1,5 @@
 py2docfx/__init__.py,sha256=kPRhPGPC1JknDotkksG428c1iIgfFr_4_7Jm-llrowY,72
-py2docfx/__main__.py,sha256=9eGiHBw-4m_Yz8rVDSJgXbVPyxh1BD8bXhzzwIAH5bE,10970
+py2docfx/__main__.py,sha256=bKG36Em2iCug0frJFXlW_Pg4YGZCVIMuluQXlvvv0qQ,10842
 py2docfx/convert_prepare/__init__.py,sha256=XxtxrP0kmW3ZBHIAoxsPDEHzcgeC0WSnole8Lk6CjKs,11
 py2docfx/convert_prepare/environment.py,sha256=AwS4c4OSwVdxlExBLVo310HrVhFMhWQ2Wh9RJPJKH1c,894
 py2docfx/convert_prepare/generate_conf.py,sha256=wqs6iyElzJarH-20_qEL9zvZvt5xfBMsGXSXPSZy6wg,2295
@@ -8,13 +8,13 @@ py2docfx/convert_prepare/get_source.py,sha256=1XOdFABdzhmSld8-w72gaOQv8_xaUX7_Vn
 py2docfx/convert_prepare/git.py,sha256=fY9urQQp5aMnlGnFrSvTTR0FPnIc-28b50W1NzIPpaw,5640
 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=8H-v-6-ta1mx3fY2o20ra1uO1lfu2mheikbarDSpK7U,6292
+py2docfx/convert_prepare/package_info.py,sha256=RCN3enfwXeU_9H8xBHLalvbhUrGxMtmlX0F9omGoPjU,6856
 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
 py2docfx/convert_prepare/repo_info.py,sha256=6ASJlhBwf6vZTSENgrWCVlJjlJVhuBxzdQyWEdWAC4c,117
 py2docfx/convert_prepare/source.py,sha256=reRr3zPG_Q8zCGaJf-7JbaO0A58RCQAURiGYamx6LEM,1449
-py2docfx/convert_prepare/sphinx_caller.py,sha256=ZeCEtJPdondwX50Gso6nPwre5VUqtVoBTtbWJ5ID5tU,4132
+py2docfx/convert_prepare/sphinx_caller.py,sha256=CQjDmZRKxTIT83Ah8LSwhdSTObCqYesTVcTRFIXtenY,4275
 py2docfx/convert_prepare/subpackage.py,sha256=mXAi_07pXvnPkSLZfykDh_7VeFxfLy74pYlzhMO8N_Q,5183
 py2docfx/convert_prepare/conf_templates/conf.py_t,sha256=VL5K6xUTIw2cb4GFjDXu5iCZFPA2Kb36KLvier78HFg,3811
 py2docfx/convert_prepare/conf_templates/master_doc.rst_t,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -23,17 +23,21 @@ py2docfx/convert_prepare/post_process/merge_toc.py,sha256=jF4u9Zb618SCSQG7u8IxCd
 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=ylSLBuAkoZStRUYYtE6tZf3C377dXN8zlrwdpe7iRLM,2255
+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=Id7mBpmuQb4dGZ-wEIYBeWlgLfOFKzLO8IETlUeZ0_o,2179
-py2docfx/convert_prepare/tests/test_params.py,sha256=Kc6JnoCbC3VvZwzPac1_46USsoZy-2YG-GrwhqFa8sI,2017
+py2docfx/convert_prepare/tests/test_package_info.py,sha256=L2ax9dItnz5QNSsSjSjEcaS6UPZxiq3MwysBB1FdJxI,2262
+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=xkbYu-F6xNBlXWW0nu0YDYwc5zNj8h67Qd-3QpJ_B0M,1281
-py2docfx/convert_prepare/tests/test_sphinx_caller.py,sha256=IgZ4Pm3-SNBgGW938NqIg8XlFbnE7lJvwoCip3uBY78,2533
+py2docfx/convert_prepare/tests/test_sphinx_caller.py,sha256=bhZJ7eH-YvjAPxPS4ANzmMqKo5SHExiCd1kvLWvPHtc,2484
 py2docfx/convert_prepare/tests/test_subpackage.py,sha256=n0lCcdrTE1gkmmfGE85tSBMlpOEBszZafaHXffxo3Oc,4982
-py2docfx/convert_prepare/tests/data/generate_document/dummy_source_code/boo/boo.py,sha256=zXze_R2qRsJsAB8Z1LY5ZGRHWDo-j3N6Tnw1yBy9gVs,97
-py2docfx/convert_prepare/tests/data/generate_document/dummy_source_code/foo/foo.py,sha256=i2oC5eoHl-HNW1mhLotsOwgdnVzkR0jRj4rnNjMbbCU,97
+py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/dummy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/dummy/sourcecode/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/dummy/sourcecode/boo/boo.py,sha256=zXze_R2qRsJsAB8Z1LY5ZGRHWDo-j3N6Tnw1yBy9gVs,97
+py2docfx/convert_prepare/tests/data/generate_document/azure-dummy-sourcecode/azure/dummy/sourcecode/foo/foo.py,sha256=i2oC5eoHl-HNW1mhLotsOwgdnVzkR0jRj4rnNjMbbCU,97
 py2docfx/convert_prepare/tests/data/get_source/mock-1/setup.py,sha256=6Zcy-AkzBIuiyU67AdApqj7nF6rNNTd8733ie0M4R-A,121
 py2docfx/convert_prepare/tests/data/pack/foo/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 py2docfx/convert_prepare/tests/data/pack/foo/foo.py,sha256=nFSS0Abt9DB2jpxbrpv6UNmDiz8pgeChJoPWsFDrRQU,14
@@ -99,7 +103,7 @@ py2docfx/docfx_yaml/tests/roots/test-translator-signatures/refered_objects.py,sh
 py2docfx/docfx_yaml/tests/roots/test-writer-table/code_with_table_desc.py,sha256=J4eFvXsymgFvjnwVUY0APtUGwuxvt-AFJjTaEaQ7zMQ,574
 py2docfx/docfx_yaml/tests/roots/test-writer-table/conf.py,sha256=avcbnIOV2mlGQwhMQJZC4W6UGRBRhnq1QBxjPWlySxQ,260
 py2docfx/docfx_yaml/tests/utils/test_utils.py,sha256=N61dPDo5vuRSWlq3FIbdmalOwxGMzbKDILpRBeN58RE,3374
-py2docfx-0.1.0.dev1465108.dist-info/METADATA,sha256=NiXZP9dXBHBsQvE-Rx91CLPZXE8P5Y2ImGHk1EZfgO4,601
-py2docfx-0.1.0.dev1465108.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-py2docfx-0.1.0.dev1465108.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.0.dev1465108.dist-info/RECORD,,
+py2docfx-0.1.0.dev1465352.dist-info/METADATA,sha256=MTA4_JXloK6UX9JPQhrICkyxad_85YqSVk31S3PE-x0,601
+py2docfx-0.1.0.dev1465352.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+py2docfx-0.1.0.dev1465352.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.0.dev1465352.dist-info/RECORD,,