docs: update API references#231
Merged
Merged
Conversation
Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates API documentation configuration to improve structure and readability. The changes focus on refining the mkdocs configuration, adding new schema members to the documentation, and adjusting display settings for better clarity.
Key changes:
- Reorganized mkdocs.yaml options with section comments and updated default values
- Added
AutolabelModelandAutolabelMixinto schema documentation - Applied
show_root_heading: falseacross multiple schema sub-items to streamline rendered output
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mkdocs.yaml | Restructured API reference plugin options with comments and updated defaults for headings, signatures, and display settings |
| docs/apis/schema/table.md | Added AutolabelModel and AutolabelMixin to filters list to exclude from main table documentation |
| docs/apis/schema/other.md | Added new schema members and applied show_root_heading: false to all sub-item sections |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What
This pull request updates the API documentation configuration and schema table documentation to improve clarity and maintain consistency. The main changes include adding new schema members, refining table filters, and reorganizing documentation options for better structure and readability.
Schema documentation updates:
AutolabelModelandAutolabelMixinto thememberslist in thet4_devkit.schema.tablesdocumentation, ensuring these new schema classes are included in the generated docs.filterslist indocs/apis/schema/table.mdto exclude the newAutolabelModelandAutolabelMixinclasses from certain documentation sections, maintaining the intended separation of core and auxiliary schema elements.Documentation formatting and structure:
show_root_heading: falsefor several schema table sub-items indocs/apis/schema/other.mdto suppress redundant headings and streamline the rendered documentation. [1] [2] [3] [4]mkdocs.yamlconfiguration for the API reference plugin to clarify and reorganize options, such as adjusting heading levels, toggling root headings, and updating display settings for class members and docstrings, leading to improved documentation structure and readability.