Publish objects.inv for Sphinx/mkdocstrings intersphinx

[adamtheturtle]

Context

Projects that depend on respx (e.g. openapi-mock) document respx types like MockRouter and Router in their API docs. Without an objects.inv file, we can't create proper cross-references—we have to add nitpick_ignore entries and lose the ability to link to respx's documentation.

Request

Please publish an objects.inv file alongside the documentation at https://lundberg.github.io/respx/. This would allow dependent projects to use intersphinx and link to respx types.

Related

• httpx has an open discussion for the same: objects.inv - available? encode/httpx#3091
• If respx uses mkdocstrings for API docs, it can generate objects.inv automatically
• Sphinx projects use intersphinx_mapping to consume it; mkdocstrings has similar support

[lundberg]

Did httpx actually add the objects.inv file?

[adamtheturtle]

It did not

[lundberg]

Not familiar with mkdocstrings plugin. If you have experience, please contribute and open a suggestion PR on how a minimal setup would look like.