httpcore icon indicating copy to clipboard operation
httpcore copied to clipboard

migrate documentation to the new experimental python handler

Open graingert opened this issue 2 years ago • 1 comments

bumping the mkdocs deps was needed to support jinja2==3.1.2 in https://github.com/encode/httpcore/pull/546/files however we're still using the legacy python handler and we should upgrade https://mkdocstrings.github.io/handlers/overview/#migrate-to-the-experimental-python-handler

graingert avatar Jun 19 '22 16:06 graingert

What benefit/changes would upgrading the python handler have for the documentation?

tomchristie avatar Jul 29 '22 13:07 tomchristie

You can see the list of features for the new handler at https://mkdocstrings.github.io/python/ — it seems like this would only be useful if you want to include a generated API reference in the documentation though.

zanieb avatar Sep 25 '22 19:09 zanieb

Okay, thanks for the suggestion.

If anyone's sufficiently motivated to open a pull request, and can demo which bits of the docs would change as a result then I'd be up for reviewing that.

tomchristie avatar Sep 26 '22 11:09 tomchristie