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

3.3.0 Feature to ignore stdlib APIs breaks CircuitPython #478

Closed
tannewt opened this issue Aug 29, 2024 · 4 comments
Closed

3.3.0 Feature to ignore stdlib APIs breaks CircuitPython #478

tannewt opened this issue Aug 29, 2024 · 4 comments
Labels

Comments

@tannewt
Copy link
Contributor

tannewt commented Aug 29, 2024

We reimplement some of the stdlib and the change in 3.3.0 causes our docs to disappear. ReadTheDocs breaks due to a missing reference.

It is important for us to list what we implement because we don't implement everything.

Please add a way to disable this behavior.

@tannewt
Copy link
Contributor Author

tannewt commented Aug 29, 2024

For example, our ssl.SSLContext.wrap_socket is no longer listed.

@tannewt
Copy link
Contributor Author

tannewt commented Aug 29, 2024

Also note that we don't do any inheritance. We're defining modules and classes with the same names as those in the stlib. So maybe ensure that these members actually come from the inheritance.

@AWhetter
Copy link
Collaborator

Sorry about this. I implemented the drastic approach of doing this filtering at the parser level, but I should have done it in such a way that you could at least use the autoapi-skip-member event to override the behaviour.
I should have some time to address the problem this weekend.

@AWhetter AWhetter added the Bug label Aug 30, 2024
@AWhetter
Copy link
Collaborator

AWhetter commented Sep 2, 2024

I've tested v3.3.1 against CircuitPython and the docs now build. The missing members look to be present in the ssl module at least. Please let me know if you're still seeing issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants