httpx icon indicating copy to clipboard operation
httpx copied to clipboard

Cross reference documentation with mkdocstrings' `objects.inv`

Open Ravencentric opened this issue 1 year ago • 2 comments
trafficstars

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

Ravencentric avatar Mar 15 '24 05:03 Ravencentric

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.)

lovelydinosaur avatar Apr 16 '24 15:04 lovelydinosaur

Reopening since it was agreed by @tomchristie on https://github.com/encode/httpx/discussions/3091#discussioncomment-11014697

Kludex avatar Nov 13 '24 09:11 Kludex