Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork980
Migrate API docs to mkdocstrings#3628
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Open
anuraaga wants to merge3 commits intoencode:masterChoose a base branch fromanuraaga:mkdocstrings
base:master
Could not load branches
Branch not found:{{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
Open
+101 −86
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Author
anuraaga commentedSep 12, 2025
@lovelydinosaur Any interest in this? If not will go ahead and close this. Thanks. |
pollier commentedSep 21, 2025
Hello, it would be great to be able to use objects.inv, generated by mkdocstring to have auto cross reference in project |
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading.Please reload this page.
Summary
Migrates API docs from
autodoctomkdocstrings. I was hoping to be able to use an httpx inventory file in some documentation and noticed there seems to be interest in it from the attached issue so tried sending a PR.I have made tweaks such as to the CSS to make it as close to the current site as possible. Though it could also make sense to have the full TOC.
The biggest difference in rendering is the docs don't have a inlet and are rendered directly. There are some other differences like font size and not showing the word
class(mkdocstrings may allow it in the future as they have an insiders-only feature for it right now).I did leave the source code previews since while very different from current, being collapsed they seemed safe to keep.
To really render using mkdocstrings, i.e. rendering out parameters in a structured way, the docstrings themselves would need to be updated to one of the supported styles like Google, numpy, or sphinx. This PR doesn't change that though to be smaller and still be quite close to what's already there, while also providing the inventory file.
To test, I run
Fixes#3145
Checklist