search

mkdocstrings / griffe-typingdoc

Griffe extension for PEP 727 – Documentation Metadata in Typing.
https://mkdocstrings.github.io/griffe-typingdoc/
ISC License
15 stars 3 forks source link

Using this with Griffe #5

Closed patrick91 closed 1 year ago

patrick91 commented 1 year ago

Hi there 👋

Would it be possible to use this with https://github.com/mkdocstrings/griffe? My documentation site doesn't use Mkdocs at the moment so I'd love to build the API docs on top of griffe and try the Annotated+Doc approach!

pawamoy commented 1 year ago

Hi!

Of course! We document the use of extensions here: https://mkdocstrings.github.io/griffe/extensions/. I don't know what tool you use to build your docs, so I'm not sure it supports passing extensions. I can chime in issues you open there :slightly_smiling_face: