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

docs(algolia): add custom attributes to backend and core methods #9730

Merged
merged 5 commits into from
Jul 31, 2024
+90 −6
Merged

docs(algolia): add custom attributes to backend and core methods #9730

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f27a4da
docs(algolia): add custom attributes to backend and core methods
gforsyth Jul 30, 2024
3ad1c06
fix(quartodoc): search up through `BaseBackend` for docstrings
gforsyth Jul 30, 2024
b98e871
fix(quartodoc): don't render deprecated schema methods
gforsyth Jul 30, 2024
49f05c3
fix(quartodoc): don't duplicate entries in resolved_bases
gforsyth Jul 30, 2024
bafb13d
feat(algolia): configure custom algolia ranking
gforsyth Jul 30, 2024
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: 5 additions & 1 deletion docs/backends/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,11 @@ def find_member_with_docstring(member):
return member

cls = member.parent
for base in cls.resolved_bases:
resolved_bases = cls.resolved_bases
# If we're a SQLBackend (likely) then also search through to `BaseBackend``
if (sqlbackend := resolved_bases[0]).name == "SQLBackend":
Copy link
Member

Choose a reason for hiding this comment

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

Is there a more generic fix for this, like altering the lookup code to traverse the class hierarchy?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, but I think it's upstream in quartodoc. I'm going to take a peak at what's involved

resolved_bases.extend(sqlbackend.resolved_bases)
for base in resolved_bases:
try:
parent_member = get_callable(base, member.name)
except KeyError:
Expand Down