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

Python API docs missing some functions #49

Closed
timhutton opened this issue Oct 20, 2022 · 2 comments · Fixed by #51
Closed

Python API docs missing some functions #49

timhutton opened this issue Oct 20, 2022 · 2 comments · Fixed by #51
Assignees
@matajoh
Labels
bug Something isn't working

Comments

@timhutton
Copy link

Example:

The python docs for Image says that the only member function is load.

However there are additional member functions load_from_buffer and from_numpy.

Presumably the issue is that the docs are generated from the C++?
@matajoh matajoh added the bug Something isn't working label Nov 3, 2022
@matajoh
Copy link
Member

matajoh commented Nov 3, 2022

They definitely used to be there. It is possible this is a result of moving to using the interface stub files. I'll look into it.

@matajoh matajoh self-assigned this Nov 3, 2022
@matajoh
Copy link
Member

matajoh commented Nov 3, 2022

This appears to be a known issue: sphinx-doc/sphinx#7630

I will see if I can find a workaround.

@matajoh matajoh mentioned this issue Nov 3, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@matajoh matajoh

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fixing the missing methods in Python documention. microsoft/scenepic
2 participants
@timhutton @matajoh