Migrate API docs to mkdocstrings #3628
Open
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.
Summary
Migrates API docs from
autodoc
tomkdocstrings
. 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