[doc] Enhance the website for structural tags. #479
Merged
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
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation for structural tag formats by integrating the sphinxcontrib-autodoc-pydantic Sphinx extension, which provides better rendering for Pydantic models including JSON schema examples.
- Adds
sphinxcontrib.autodoc_pydanticextension to Sphinx configuration - Configures the extension to display JSON examples for Pydantic models
- Updates all structural tag format class documentation directives from
autoclasstoautopydantic_model
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/conf.py | Adds sphinxcontrib.autodoc_pydantic extension and configures it to show JSON examples for Pydantic models |
| docs/api/python/structural_tag.rst | Updates all 11 format class documentation directives from autoclass to autopydantic_model for better Pydantic model rendering |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Ubospica
approved these changes
Nov 27, 2025
Signed-off-by: Yuchuan <[email protected]>
Signed-off-by: Yuchuan <[email protected]>
Signed-off-by: Yuchuan <[email protected]>
Seven-Streams
force-pushed
the
web/2025-11-22/stag
branch
from
62ec490 to
fa31769
Compare
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.
This PR enhances the website for structural tags.