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

add initial marshmallow support #51

Merged
merged 6 commits into from Jul 15, 2020
Merged

Conversation

stufisher
Copy link
Contributor

Basic support for marshmallow schemas https://marshmallow.readthedocs.io/en/stable/

It would be nice if we could override the default renderer for these types of classes to show a table instead of the header style renderer?

@stufisher
Copy link
Contributor Author

I would like to show inherited fields as well, however enabling inherited_members also shows all the methods inherited from the base marshmallow.Schema class. I added a blacklist to remove these methods / attributes, but there may be a cleaner way to deal with this that i am not seeing

@pawamoy
Copy link
Member

pawamoy commented Jun 19, 2020

Hi @stufisher, thanks a lot for your contributions, this is really appreciated 🙂

I'll review now!

src/pytkdocs/loader.py Outdated Show resolved Hide resolved
src/pytkdocs/loader.py Outdated Show resolved Hide resolved
src/pytkdocs/loader.py Outdated Show resolved Hide resolved
@stufisher
Copy link
Contributor Author

stufisher commented Jun 19, 2020

Thanks for reviewing, ill get back to you shortly with updates. Any idea on my second question about formatting via tables? I guess ill open an mkdocstrings ticket

@stufisher
Copy link
Contributor Author

Sorry for the delays, think ive addressed the things youve mentioned :)

@pawamoy
Copy link
Member

pawamoy commented Jul 15, 2020

Hi again, no problem about the delays, I myself am having a hard time finding time/motivation to work on my open source projects in the evenings, after work 🙂 Thank you for getting back on this 🙂

I think this is good now, I'll squash and merge!

@pawamoy pawamoy merged commit c250466 into mkdocstrings:master Jul 15, 2020
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.

None yet

2 participants