Skip to content

Fix logic for detection of support files in docs #1580

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

Merged
merged 1 commit into from
Jul 29, 2024
Merged

Fix logic for detection of support files in docs #1580

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
6 changes: 3 additions & 3 deletions shiny/_docstring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,17 +154,17 @@ def _(func: F) -> F:

other_files: list[str] = []
for abs_f in Path(example_dir).glob("**/*"):
path_parts = Path(abs_f).parts
rel_f = abs_f.relative_to(example_dir)
f = os.path.basename(abs_f)
path_parts = Path(rel_f).parts
f = os.path.basename(rel_f)
Comment on lines +158 to +159
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! This is the same fix I thought of before looking at the changes :)

is_support_file = (
os.path.isfile(abs_f)
and f != app_file_name
and f != "app.py"
and f != ".DS_Store"
and "venv" not in path_parts
and ".venv" not in path_parts
and not f.startswith("app-")
and not (f.startswith("app-") and f.endswith(".py"))
and not str(rel_f).startswith("__")
)
if is_support_file:
Expand Down