docs: style API reference docs#1516
Merged
dgarcia360 merged 2 commits intomasterfrom Nov 20, 2025
Merged
Conversation
This was referenced Nov 17, 2025
dgarcia360
force-pushed
the
docs-style-api-reference
branch
from
674a4a2 to
06db70c
Compare
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
2 participants
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.
Motivation
Styles the API reference docs. Main edits:
Add sample docs on how to generate API docs from Python code, Doxygen (C - Java), and REST APIs.
Styled API references to be more scanneable (indentation, spacing, color usage):
Added a copy button to code related headings:
Added 3 levels of navigation on the right sidebar (new default). Configurable up to 4 levels:
How to test