Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cross reference documentation with mkdocstrings' objects.inv #3145

Open
Ravencentric opened this issue Mar 15, 2024 · 2 comments
Open

Cross reference documentation with mkdocstrings' objects.inv #3145

Ravencentric opened this issue Mar 15, 2024 · 2 comments
Labels
docs Changes to the documentation

Comments

@Ravencentric
Copy link

Discussed in #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 Ravencentric changed the title Docum Cross reference documentation reference with mkdocstrings' objects.inv Mar 15, 2024
@Ravencentric Ravencentric changed the title Cross reference documentation reference with mkdocstrings' objects.inv Cross reference documentation with mkdocstrings' objects.inv Mar 15, 2024
@tomchristie
Copy link
Member

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

@tomchristie tomchristie closed this as not planned Won't fix, can't repro, duplicate, stale Apr 16, 2024
@Kludex
Copy link
Member

Kludex commented Nov 13, 2024

Reopening since it was agreed by @tomchristie on #3091 (reply in thread)

@Kludex Kludex reopened this Nov 13, 2024
@Kludex Kludex self-assigned this Nov 13, 2024
@Kludex Kludex added the docs Changes to the documentation label Nov 13, 2024
@Kludex Kludex removed their assignment Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Changes to the documentation
Projects
None yet
Development

No branches or pull requests

3 participants