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.

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

[DOC] fix_sionna_folder no longer working #201

Open
1 task done
jeertmans opened this issue Jan 14, 2025 · 0 comments
Open
1 task done

[DOC] fix_sionna_folder no longer working #201

jeertmans opened this issue Jan 14, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation needs-triage This issue has not been manually labelled yet

Comments

@jeertmans
Copy link
Owner

Terms

Describe the issue

It appears that the current function used to patch the name of the default folder in the docs, i.e.,

DiffeRT/docs/source/conf.py

Lines 240 to 254 in 79c0fe5

def fix_sionna_folder(_app: Sphinx, obj: Any, _bound_method: bool) -> None:
"""
Rename the default folder to a more readeable name.
"""
if obj.__name__.endswith("_sionna_scene"):
sig = inspect.signature(obj)
parameters = []
for param_name, parameter in sig.parameters.items():
if param_name == "folder":
parameter = parameter.replace(default="<path-to-differt>/scene/scenes") # noqa: PLW2901
parameters.append(parameter)
obj.__signature__ = sig.replace(parameters=parameters)

no longer works.

See:
image

I tried to bisect commits to find the root of the issue, without success.

Affected page(s)

Issue type

Typo, spelling mistake, broken link, etc.

Recommended fix or suggestions

Do not know how to solve this yet.

@jeertmans jeertmans added documentation Improvements or additions to documentation needs-triage This issue has not been manually labelled yet labels Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs-triage This issue has not been manually labelled yet
Projects
None yet
Development

No branches or pull requests

1 participant