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

Renderer: show class bases #224

Open
machow opened this issue Jul 25, 2023 · 1 comment
Open

Renderer: show class bases #224

machow opened this issue Jul 25, 2023 · 1 comment

Comments

@machow
Copy link
Owner

machow commented Jul 25, 2023

For class documentation, let's add an option to render the inheritance chain (and set it True by default).

Here is where it lives on the object:

from quartodoc import get_object

obj = get_object("quartodoc.MdRenderer")
obj.bases
@machow
Copy link
Owner Author

machow commented Aug 8, 2023

Here is what it looks like:

image

  • Let's add the option show_bases to layout.Auto
  • Note that the parent class is clickable (we can sort that out later; I think maybe we should call .render_annotation() on it or something.)
  • test via snapshot (in test_renderers.py)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

2 participants