-
Notifications
You must be signed in to change notification settings - Fork 3
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
🐛 Hide from_public from TOC #135
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: zethson <lukas.heumos@posteo.net>
Signed-off-by: zethson <lukas.heumos@posteo.net>
Signed-off-by: zethson <lukas.heumos@posteo.net>
Signed-off-by: zethson <lukas.heumos@posteo.net>
Signed-off-by: zethson <lukas.heumos@posteo.net>
Signed-off-by: zethson <lukas.heumos@posteo.net>
Zethson
changed the title
🐛 Deprecate from_public correctly
🐛 Hide from_public from TOC
Oct 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #134
Things I Tried That Didn't Work:
__getattr__
on the Class: This only works for instance attributes, not class methods likefrom_public
. It didn't intercept class-level method calls.Metaclass Solution: Adding a custom metaclass (
BioRecordMeta
) caused conflicts with existing metaclasses used by Django models, resulting in a "metaclass conflict" error.Removing the Docstring (
__doc__ = None
): While this removed the method's documentation,from_public
still showed up in Sphinx's table of contents (TOC) since the method itself was still present.__dir__
Override: Hiding the method via__dir__
didn't prevent Sphinx from listingfrom_public
becauseSphinx
relies on more than justdir()
for introspection.Sphinx Event Hook: Registering the
autodoc-skip-member
event handler required access toconf.py
.What Finally Worked:
__init_subclass__
: This method was overridden to dynamically add thefrom_public
method to each subclass only when Sphinx was not running. This ensures thatfrom_public
is available for backward compatibility at runtime but hidden from Sphinx documentation.