Skip to content

Commit

Permalink
fix(algolia): add parent class docstring to algolia index
Browse files Browse the repository at this point in the history
Follow-up to ibis-project#9730.

I fixed adding the parent docstrings in the rendered docs, but those
weren't showing up in the search summary on Algolia.  They do now.
  • Loading branch information
gforsyth committed Jul 31, 2024
1 parent 4d110a0 commit ae0a7bd
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/backends/_utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,11 @@ def dump_methods_to_json_for_algolia(backend, methods):
"objectID": base_url,
"href": base_url,
"title": f"{backend_name}.Backend.{method}",
"text": getattr(backend.all_members[method].docstring, "value", ""),
"text": getattr(
find_member_with_docstring(backend.all_members[method]).docstring,
"value",
"",
),
"crumbs": ["Backend API", "API", f"{backend_name} methods"],
}

Expand Down

0 comments on commit ae0a7bd

Please sign in to comment.