py2docfx 0.1.9.dev1861949__py3-none-any.whl → 0.1.9.dev1862202__py3-none-any.whl

py2docfx/__main__.py

@@ -1,6 +1,7 @@
 from __future__ import annotations # Avoid A | B annotation break under <= py3.9
 import argparse
 import os
+import subprocess
 import sys
 import time
 
@@ -240,8 +241,21 @@ def donwload_package_generate_documents(
         end_time = time.time()
         print(f"<install_package>{package.name},{end_time-start_time}<install_package/>")
 
+        venv_dir = os.path.join(PACKAGE_ROOT, "venv", "0")
+        subprocess.run([sys.executable, "-m", "venv", venv_dir], check=True)
+        venv_exe = os.path.join(venv_dir, "Scripts", "python.exe")
+        subprocess.run([venv_exe, "-m", "pip", "install", "sphinx==6.1.3"], check=True)
+        subprocess.run([venv_exe, "-m", "pip", "install", "setuptools"], check=True)
+        subprocess.run([venv_exe, "-m", "pip", "install", "pyyaml"], check=True)
+        subprocess.run([venv_exe, "-m", "pip", "install", "jinja2==3.0.3"], check=True)
+        if package.version:
+            pkg_install_str = package.name + "==" + package.version
+        else:
+            pkg_install_str = package.name
+        subprocess.run([venv_exe, "-m", "pip", "install", pkg_install_str], check=True)
+        
         start_time = time.time()
-        generate_document(package, output_root)
+        generate_document(package, output_root, venv_exe)
         end_time = time.time()
         print(f"<generate_document>{package.name},{end_time-start_time}<generate_document/>")
 

py2docfx/convert_prepare/generate_document.py

@@ -1,9 +1,8 @@
 from __future__ import annotations # Avoid A | B annotation break under <= py3.9
 import os
-import subprocess
 import sys
 import time
-from py2docfx import PACKAGE_ROOT
+
 from py2docfx.convert_prepare.generate_conf import generate_conf
 from py2docfx.convert_prepare.git import checkout
 from py2docfx.convert_prepare.package_info import PackageInfo
@@ -12,7 +11,7 @@ from py2docfx.convert_prepare.subpackage import merge_subpackage_files
 
 CONF_TEMPLATE_DIR = os.path.join(os.path.dirname(os.path.realpath(__file__)), "conf_templates")
 
-def generate_document(pkg: PackageInfo, output_root: str | os.PathLike):
+def generate_document(pkg: PackageInfo, output_root: str | os.PathLike, executable=sys.executable):
     start_time = time.time()
     # Copy manual written RST from target doc repo
     package_paths = pkg.path
@@ -47,21 +46,8 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike):
     end_time = time.time()
     print(f"<generate_conf>{pkg.name},{end_time-start_time}<generate_conf/>")
     
-    venv_dir = os.path.join(PACKAGE_ROOT, "venv", "0")
-    subprocess.run([sys.executable, "-m", "venv", venv_dir], check=True)
-    venv_exe = os.path.join(venv_dir, "Scripts", "python.exe")
-    subprocess.run([venv_exe, "-m", "pip", "install", "sphinx==6.1.3"], check=True)
-    subprocess.run([venv_exe, "-m", "pip", "install", "setuptools"], check=True)
-    subprocess.run([venv_exe, "-m", "pip", "install", "pyyaml"], check=True)
-    subprocess.run([venv_exe, "-m", "pip", "install", "jinja2==3.0.3"], check=True)
-    if pkg.version:
-        pkg_install_str = pkg.name + "==" + pkg.version
-    else:
-        pkg_install_str = pkg.name
-    subprocess.run([venv_exe, "-m", "pip", "install", pkg_install_str], check=True)
-    
     start_time = time.time()
-    run_converter(package_paths.doc_folder, package_paths.yaml_output_folder, executable=venv_exe)
+    run_converter(package_paths.doc_folder, package_paths.yaml_output_folder, executable=executable)
     end_time = time.time()
     print(f"<run_converter>{pkg.name},{end_time-start_time}<run_converter/>")
     subpackages_path_record = {}
@@ -71,7 +57,7 @@ def generate_document(pkg: PackageInfo, output_root: str | os.PathLike):
         for (subpackage_name, subpackage_path) in subpackages_rst_record.items():
             subpackage_yaml_path = os.path.join(subpackages_yaml_path, subpackage_name)
             subpackages_path_record[subpackage_name] = subpackage_yaml_path
-            run_converter(subpackage_path, subpackage_yaml_path, executable=venv_exe)
+            run_converter(subpackage_path, subpackage_yaml_path, executable=executable)
 
         merge_subpackage_files(subpackages_path_record, package_paths.yaml_output_folder, pkg.name)
         end_time = time.time()

py2docfx/convert_prepare/tests/test_generate_document.py

@@ -0,0 +1,53 @@
+"""
+Test the generate_document function.
+"""
+import os
+import sys
+import shutil
+from py2docfx.convert_prepare.generate_document import generate_document
+from py2docfx.convert_prepare.package_info import PackageInfo
+from py2docfx.convert_prepare.source import Source
+
+def test_generate_document(tmp_path):
+    """
+    Test the generate_document function.
+    """
+    # init test case
+    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 = "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\\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
+    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"))
+
+    # call the function
+    generate_document(package, output_root)
+
+    #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, "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"))

{py2docfx-0.1.9.dev1861949.dist-info → py2docfx-0.1.9.dev1862202.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2docfx
-Version: 0.1.9.dev1861949
+Version: 0.1.9.dev1862202
 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.9.dev1861949.dist-info → py2docfx-0.1.9.dev1862202.dist-info}/RECORD

@@ -1,9 +1,9 @@
 py2docfx/__init__.py,sha256=kPRhPGPC1JknDotkksG428c1iIgfFr_4_7Jm-llrowY,72
-py2docfx/__main__.py,sha256=GqWpjtCsIlKzE9_FDFBV4fJbKvgyFoYUvMYJqUfZBKI,12074
+py2docfx/__main__.py,sha256=9S3iXVNDrgX2Avhzh7jRTbcS4Jib5Ht9zH4UGGnBP8k,12911
 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
-py2docfx/convert_prepare/generate_document.py,sha256=nZnbThthpCgPu5YGuFnWQSRRiDuJBpVqsTgLKYNj1m8,3879
+py2docfx/convert_prepare/generate_document.py,sha256=cLfFr7od0RHADkXyh2gaPreXZGvKNBUlduBosYTuPbk,3118
 py2docfx/convert_prepare/get_source.py,sha256=eEIbfLkGdBSOIJElMBTiXkKlkujb_hdFu5g6InNroTg,5851
 py2docfx/convert_prepare/git.py,sha256=xGJp2nDWLfVljrxyPnFKPoLIqmBh6by-QdITogIuxi0,5893
 py2docfx/convert_prepare/install_package.py,sha256=hATmgazcSX7k2n4jQXh9sQMyNUc1k1YqHv5K5UMALq4,262
@@ -23,6 +23,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=FpxwyRQFBfEdYUH16tpcJrqTAC0J5mq-Edn-N7Lz0rY,2413
 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
@@ -5330,7 +5331,7 @@ py2docfx/venv/0/Scripts/rst2s5.py,sha256=qup0-LMkBGLuh6Bj-1n8ucEVc5T8ANpqL0Pscmp
 py2docfx/venv/0/Scripts/rst2xetex.py,sha256=FNBX2UuBN3vqJQss_DdqjMBSU5BQmOFGLOZV8DSNAuk,905
 py2docfx/venv/0/Scripts/rst2xml.py,sha256=7uyNsZb5QOV243R-EQqdsyUKX7t5_9sQd6LYtw1ZyPA,634
 py2docfx/venv/0/Scripts/rstpep2html.py,sha256=p-PYRUWuvD1LWAzofxrQu_Go3SMfIS8q0pmy6HT2Y5E,702
-py2docfx-0.1.9.dev1861949.dist-info/METADATA,sha256=fwvuv5S6J2-6S42KgT8bWHICqOhrLVAI4VGMFmEx5A4,600
-py2docfx-0.1.9.dev1861949.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-py2docfx-0.1.9.dev1861949.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
-py2docfx-0.1.9.dev1861949.dist-info/RECORD,,
+py2docfx-0.1.9.dev1862202.dist-info/METADATA,sha256=PWPfdvmRmSpmGVO9kVCsuzcyT2ublC4JGMRJ6EDsWFY,600
+py2docfx-0.1.9.dev1862202.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+py2docfx-0.1.9.dev1862202.dist-info/top_level.txt,sha256=5dH2uP81dczt_qQJ38wiZ-gzoVWasfiJALWRSjdbnYU,9
+py2docfx-0.1.9.dev1862202.dist-info/RECORD,,