Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sphinx: Make .pyi files available #699

Open
wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Sphinx: Make .pyi files available #699

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import shutil
import subprocess
import sys
import urllib.request
Expand Down Expand Up @@ -211,3 +212,26 @@
"cp impactx-doxygen-web.tag.xml source/_static/doxyhtml/",
shell=True,
)

# Copy .pyi interface files and make them available as .py files
# path to .pyi files w/o having them installed
src_path = "../../src/python/impactx"
dst_path = os.path.join(
os.path.dirname(os.path.abspath(__file__)), "_static/pyapi/impactx"
)
if os.path.exists(dst_path) and os.path.isdir(dst_path):
shutil.rmtree(dst_path)
shutil.copytree(src_path, dst_path)

for subdir, _dirs, files in os.walk(dst_path):
for f in files:
if f.find(".pyi") > 0:
dir_path = os.path.relpath(subdir, dst_path)
old_path = os.path.join(dir_path, f)
new_path = old_path.replace(".pyi", ".py")
os.replace(
os.path.join(dst_path, old_path), os.path.join(dst_path, new_path)
)

# insert into PYTHONPATH
sys.path.insert(0, os.path.join(dst_path, ".."))
Loading