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

show base classes #260

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

show base classes #260

wants to merge 7 commits into from

Conversation

hamelsmu
Copy link
Collaborator

@hamelsmu hamelsmu commented Sep 1, 2023

Still having an issue getting MdRenderer to show up properly. @machow do you think this bug still exists that you mentioned earlier. I was able to retrace all the steps and I think I understand the code base a bit better now, but I am not sure where to start debugging this specific issue.

I'll try to take a break from this and come back to it

@machow
Copy link
Owner

machow commented Sep 11, 2023

Still having an issue getting MdRenderer to show up properly.

Shoot -- I think it was likely a matter of me needing to document that options currently don't get combined together. So, if you set options at the top-level, and then set them in a section, only the ones in the section get applied.

I added some documentation to this PR of how options get applied, and how they can be combined using YAML merge keys. It's def fair game to raise whether or not they should get combined, though 😓.

Debugging Auto

Here's what I ran to confirm that show_bases at least worked for individual pieces of content

from quartodoc import Auto, blueprint, MdRenderer
obj = Auto(name = "quartodoc.tests.example_class.Child", show_bases=True)

MdRenderer().render(blueprint(obj))
# quartodoc.tests.example_class.Child { #quartodoc.tests.example_class.Child }

`tests.example_class.Child()`



Bases: `C`



## Methods

| Name | Description |
| --- | --- |
| [some_new_method](#quartodoc.tests.example_class.Child.some_new_method) | A new method |

### some_new_method { #quartodoc.tests.example_class.Child.some_new_method }

`tests.example_class.Child.some_new_method(self)`

A new method

Debugging yaml config

Here's the stripped down yaml config I used to get a minimal example

quartodoc:
  package: quartodoc
  options:
    show_bases: true
  sections:
    - options:
        dynamic: true
      contents:
        - name: MdRenderer

Updated docs

image

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

Successfully merging this pull request may close these issues.

2 participants