search

encode / httpx

A next generation HTTP client for Python. 🦋
https://www.python-httpx.org/
BSD 3-Clause "New" or "Revised" License
12.7k stars 811 forks source link

Cross reference documentation with mkdocstrings' `objects.inv` #3145

Closed Ravencentric closed 2 months ago

Ravencentric commented 3 months ago

Discussed in https://github.com/encode/httpx/discussions/3091

Well I say discussed but in reality it got no response so i'm trying to follow up. Does httpx provide objects.inv for documentation cross-reference? mkdocstrings generates this automatically unless explicitly disabled and it allows for third party packages relying on httpx to better document their projects and easily refer to httpx's documentation.

https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories

tomchristie commented 2 months ago

Hey @Ravencentric - thanks for the prompt. Have responded on the discussion as a starting point.

(Closing the issue for the moment, but up for the discussion and reopening if we get to a clear resolution.)