py2docfx 0.1.9.dev1817546__py3-none-any.whl → 0.1.10__py3-none-any.whl

py2docfx/__main__.py

@@ -2,8 +2,6 @@ from __future__ import annotations # Avoid A | B annotation break under <= py3.9
 import argparse
 import os
 import sys
-import time
-
 from py2docfx import PACKAGE_ROOT
 from py2docfx.convert_prepare.generate_document import generate_document
 from py2docfx.convert_prepare.get_source import get_source, YAML_OUTPUT_ROOT
@@ -229,7 +227,6 @@ def donwload_package_generate_documents(
         github_token: str, ado_token: str, start_num: int):
 
     for idx, package in enumerate(package_info_list):
-        start_time = time.time()
         package_number = start_num + idx
         get_source(package, package_number, vststoken=ado_token, githubtoken=github_token)
         install_package(package)
@@ -237,10 +234,6 @@ def donwload_package_generate_documents(
         merge_toc(YAML_OUTPUT_ROOT, package.path.yaml_output_folder)
         if output_doc_folder:
             package.path.move_document_to_target(os.path.join(output_doc_folder, package.name))
-        end_time = time.time()
-        print(f"Time to download package {package.name} and generate documents: {end_time - start_time} seconds")
-        with open(os.path.join(PACKAGE_ROOT, "time.txt"), "a") as f:
-            f.write(f"Time to download package {package.name} and generate documents: {end_time - start_time} seconds\n")
     if output_doc_folder:
         move_root_toc_to_target(YAML_OUTPUT_ROOT, output_doc_folder)
 
@@ -265,25 +258,14 @@ def prepare_out_dir(output_root: str | os.PathLike) -> os.PathLike | None:
 def main(argv) -> int:
     (package_info_list, required_package_list, github_token, ado_token, output_root, \
           venv_required) = parse_command_line_args(argv)
-    venv_required = False
     if venv_required and sys.prefix == sys.base_prefix:
         raise ValueError("""Please run in a virtual env to prevent breaking your dev
                         environment when not running on pipeliens""")
     output_doc_folder = prepare_out_dir(output_root)
-    start_time = time.time()
     install_required_packages(required_package_list, github_token, ado_token)
-    end_time = time.time()
-    print(f"Time to install required packages: {end_time - start_time} seconds")
-    with open(os.path.join(PACKAGE_ROOT, "time.txt"), "a") as f:
-        f.write(f"Time to install required packages: {end_time - start_time} seconds\n")
-    start_time = time.time()
     donwload_package_generate_documents(
         package_info_list, output_root, output_doc_folder,
         github_token, ado_token, len(list(required_package_list)))
-    end_time = time.time()
-    print(f"Time to download packages and generate documents: {end_time - start_time} seconds")
-    with open(os.path.join(PACKAGE_ROOT, "time.txt"), "a") as f:
-        f.write(f"Time to download packages and generate documents: {end_time - start_time} seconds\n")
     return 0
 
 if __name__ == "__main__":

py2docfx/convert_prepare/package_info.py

@@ -32,7 +32,7 @@ class PackageInfo:
         package_info = PackageInfo()
         package_info.exclude_path = dict.get("exclude_path", [])
         package_info.extension_config = dict.get("extension_config", {})
-
+        package_info.sphinx_extensions = dict.get("sphinx_extensions", [])
         if reading_required_packages:
             package_info_dict = dict
         else:

py2docfx/convert_prepare/tests/test_package_info.py

@@ -17,6 +17,8 @@ package_info_1 = PackageInfo.parse_from(test_dict["packages"][1], False)
 
 package_info_2 = PackageInfo.parse_from(test_dict["packages"][2], False)
 
+package_info_3 = PackageInfo.parse_from(test_dict["packages"][3], False)
+
 def test_parse_from():
     assert package_info_0.exclude_path == ["test*", "example*", "sample*", "doc*"]
     assert package_info_0.name == "azure-mltable-py2docfxtest"
@@ -26,6 +28,11 @@ def test_get_combined_name_version():
     name_version = package_info_1.get_combined_name_version()
     assert name_version == "azureml-accel-models==1.0.0"
 
+def test_get_sphinx_extensions():
+    assert package_info_3.sphinx_extensions == ["sphinx-pydantic"]
+    assert package_info_3.name == "semantic-kernel"
+    assert package_info_3.install_type.name == "PYPI"
+
 def test_intall_command():
     install_command = package_info_0.get_install_command()
     assert install_command[0] == "azure-mltable-py2docfxtest"
@@ -35,28 +42,6 @@ def test_intall_command():
     assert install_command[0] == "azureml-accel-models==1.0.0"
     assert install_command[1] == []
 
-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(tmp_path):
     source_folder = os.path.join(tmp_path,"source_folder")
     yaml_output_folder = os.path.join(tmp_path,"yaml_output_folder")

py2docfx/convert_prepare/tests/test_params.py

@@ -21,6 +21,11 @@ def package_info_assert(package_info_list, required_package_info_list):
     assert package.install_type.name == "PYPI"
     assert package.exclude_path == []
 
+    package = package_info_list[3]
+    assert package.name == "semantic-kernel"
+    assert package.install_type.name == "PYPI"
+    assert package.sphinx_extensions == ["sphinx-pydantic"]
+
     required_package = required_package_info_list[0]
     assert required_package.name == None
     assert required_package.install_type.name == "DIST_FILE"

{py2docfx-0.1.9.dev1817546.dist-info → py2docfx-0.1.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.9.dev1817546
+Version: 0.1.10
 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
@@ -10,7 +10,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9
-Requires-Dist: sphinx ==6.1.3
+Requires-Dist: sphinx==6.1.3
 Requires-Dist: pyyaml
 Requires-Dist: wheel
 

{py2docfx-0.1.9.dev1817546.dist-info → py2docfx-0.1.10.dist-info}/RECORD

@@ -1,5 +1,5 @@
 py2docfx/__init__.py,sha256=kPRhPGPC1JknDotkksG428c1iIgfFr_4_7Jm-llrowY,72
-py2docfx/__main__.py,sha256=yc_yJ8MAEJgPKv3R9cSUM-BzFGIgVM3gwrnqp8wz1dc,11785
+py2docfx/__main__.py,sha256=oN3abj4Z6abbyjgYHkRQ5VGQSWf6WAk90YR37gifbQw,10747
 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,7 +8,7 @@ py2docfx/convert_prepare/get_source.py,sha256=o13Ka_zBjekF_7lhHkyi6GSy4E5cWTnnIt
 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=V-xasck6ZfqJdUjlGHtkC1iE-DCBDAMK8Z0q-NronkE,7254
+py2docfx/convert_prepare/package_info.py,sha256=vRkFKuBxxIm4yyb2daWTzdISma8pL-RMqu3cp5Kx1Fg,7328
 py2docfx/convert_prepare/package_info_extra_settings.py,sha256=u5B5e8hc0m9PA_-0kJzq1LtKn-xzZlucwXHTFy49mDg,1475
 py2docfx/convert_prepare/params.py,sha256=PXMB8pLtb4XbfI322avA47q0AO-TyBE6kZf7FU8I6v4,1771
 py2docfx/convert_prepare/paths.py,sha256=964RX81Qf__rzXgEATfqBNFCKTYVjLt9J7WCz2TnNdc,485
@@ -26,8 +26,8 @@ py2docfx/convert_prepare/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5
 py2docfx/convert_prepare/tests/test_generate_document.py,sha256=hOAtib9pTFaZCS8QbYS6Dhz0hNGESDHPXumRIuIWp4Y,2415
 py2docfx/convert_prepare/tests/test_get_source.py,sha256=70EVlIZe71aDYDOXMnhqzZclKL8KuIg4t-X0U-pVyhA,7429
 py2docfx/convert_prepare/tests/test_pack.py,sha256=46JWMNzknIptDVs7D3CuxcmqBr_OKMmaw1br9H7wqco,4134
-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_package_info.py,sha256=3B-IzmUjETVO-5s3g3Lmh2E6JgopwnRauv8mB-SDZEM,3361
+py2docfx/convert_prepare/tests/test_params.py,sha256=C-aY9xDjsNTcGQATco_J_i4nF4JSmaeFPEMI3-NtiGE,2229
 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
 py2docfx/convert_prepare/tests/test_sphinx_caller.py,sha256=bhZJ7eH-YvjAPxPS4ANzmMqKo5SHExiCd1kvLWvPHtc,2484
@@ -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.9.dev1817546.dist-info/METADATA,sha256=fUNo0M0ip5XJ1IDq49V3bncNheWrYm3S5jI1HrNJ5ng,601
-py2docfx-0.1.9.dev1817546.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-py2docfx-0.1.9.dev1817546.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.9.dev1817546.dist-info/RECORD,,
+py2docfx-0.1.10.dist-info/METADATA,sha256=NNOcAHG9usYjlAP9bCu_uKk9g8yJmsZckG9rIC4FKmA,590
+py2docfx-0.1.10.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+py2docfx-0.1.10.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.10.dist-info/RECORD,,

{py2docfx-0.1.9.dev1817546.dist-info → py2docfx-0.1.10.dist-info}/WHEEL

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