docs(api, docs): port Python API documentation to mkdocs #20121
+16,423
−2,539
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
Sign up for free
to 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.
Overview
This PR ports the entire Python Protocol API documentation from Sphinx to mkdocs.
Test Plan and Hands on Testing
Sandbox
Changelog
A lot. Will list out more soon.
The commit log for this PR tells a more complete story of the process for conversion.
Review requests
The primary concern is that the converted docs retain all of the same content of the original docs, without errors.
Risk assessment
Medium. Touches every single Python API docstring.