Skip to content

docs: update API references#231

Merged
ktro2828 merged 1 commit into
mainfrom
docs/api-references
Nov 19, 2025
Merged

docs: update API references#231
ktro2828 merged 1 commit into
mainfrom
docs/api-references

Conversation

@ktro2828

Copy link
Copy Markdown
Collaborator

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:

  • Added AutolabelModel and AutolabelMixin to the members list in the t4_devkit.schema.tables documentation, ensuring these new schema classes are included in the generated docs.
  • Updated the filters list in docs/apis/schema/table.md to exclude the new AutolabelModel and AutolabelMixin classes from certain documentation sections, maintaining the intended separation of core and auxiliary schema elements.

Documentation formatting and structure:

  • Set show_root_heading: false for several schema table sub-items in docs/apis/schema/other.md to suppress redundant headings and streamline the rendered documentation. [1] [2] [3] [4]
  • Refactored the mkdocs.yaml configuration 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.

Signed-off-by: ktro2828 <kotaro.uetake@tier4.jp>
Copilot AI review requested due to automatic review settings November 18, 2025 15:34

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 AutolabelModel and AutolabelMixin to schema documentation
  • Applied show_root_heading: false across 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.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 18, 2025
@ktro2828 ktro2828 merged commit d144614 into main Nov 19, 2025
4 of 5 checks passed
@ktro2828 ktro2828 deleted the docs/api-references branch November 19, 2025 00:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants