mkdocstrings icon indicating copy to clipboard operation
mkdocstrings copied to clipboard

Attrs Support

Open LordOfPolls opened this issue 4 years ago • 11 comments

Is your feature request related to a problem? Please describe. As of right now, this library does not support attrs dataclasses. Default values or types are not recognised.

Describe the solution you'd like Attrs to be detected and their attributes documented correctly

Describe alternatives you've considered Writing the documentation in the class docstring manually.

Additional context Attrs: https://www.attrs.org/en/stable/

LordOfPolls avatar Sep 17 '21 18:09 LordOfPolls

As per https://github.com/mkdocstrings/mkdocstrings/issues/317#issuecomment-922075687, the new extractor will make it easy to write extensions to support third-party libs such as attrs.

pawamoy avatar Sep 17 '21 20:09 pawamoy

Any chance to bump this? :)

davfsa avatar Aug 01 '22 15:08 davfsa

I attempted to implement an extension for Griffe. However it really needs to be a post processing extension. To my knowledge this isn't possible yet

LordOfPolls avatar Aug 01 '22 15:08 LordOfPolls

Thank you for giving it a try @LordOfPolls. Post-processing extensions are on the Griffe to do list :slightly_smiling_face: I'll also try to think a bit more about attrs support in particular.

pawamoy avatar Aug 17 '22 19:08 pawamoy

Hi @pawamoy, just checking in; has there been any movement on this?

LordOfPolls avatar Apr 11 '23 05:04 LordOfPolls

Hey @LordOfPolls, no movement yet! But I've recently announced that I'm now working full-time on open source, so the development pace of mkdocstrings should greatly increase :slightly_smiling_face:

pawamoy avatar Apr 12 '23 13:04 pawamoy

Oh neat, congratulations on the move. If attrs support became a insiders feature, i'd definitely jump on your sponsors list

LordOfPolls avatar Apr 12 '23 17:04 LordOfPolls