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

Generating class diagrams for docs fails (silently) and breaks diagrams #1123

Open
MusicalNinjaDad opened this issue Feb 19, 2024 · 0 comments · May be fixed by #1124
Open

Generating class diagrams for docs fails (silently) and breaks diagrams #1123

MusicalNinjaDad opened this issue Feb 19, 2024 · 0 comments · May be fixed by #1124

Comments

@MusicalNinjaDad
Copy link

MusicalNinjaDad commented Feb 19, 2024 •
edited

Operating system: Bookworm, Bullseye
Python version: 3.9, 3.11 & 3.12
Pi model: N/A
GPIO Zero version: 2.0.1
Pin factory used: N/A

Regenerating the class diagrams for the docs leads to blank diagrams (dot, png & svg files are affected). This occurs via both make doc and make preview

Initial debugging suggests that the issue is (at least partly) due to the interaction of:

gpiozero/scripts/class_graph

Line 121 in 6bfab8a

for py_file in p.parent.glob(p.name):

and

gpiozero/setup.cfg

Line 119 in 6bfab8a

gpiozero/**/*.py

which equates to for py_file in PROJECT_ROOT/'gpiozero/**'.glob('*.py')

I think that what is actually wanted is for py_file in PROJECT_ROOT/'gpiozero'.glob('**/*.py')
@MusicalNinjaDad MusicalNinjaDad linked a pull request Feb 19, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix class graph generation MusicalNinjaDad/gpiozero
1 participant
@MusicalNinjaDad