Skip to content

Conversation

@amiclaus
Copy link
Contributor

Pull Request Description

Add exclusion mechanism for driver categories that don't require README.rst files. The drivers/api folder is now excluded from the documentation check as it contains interface files rather than driver implementations. Additional categories can be easily added to the excluded_categories array in the future.

PR Type

  • Bug fix (change that fixes an issue)
  • New feature (change that adds new functionality)
  • Breaking change (has dependencies in other repos or will cause CI to fail)

PR Checklist

  • I have followed the Coding style guidelines
  • I have complied with the Submission Checklist
  • I have performed a self-review of the changes
  • I have commented my code, at least hard-to-understand parts
  • I have build all projects affected by the changes in this PR
  • I have tested in hardware affected projects, at the relevant boards
  • I have signed off all commits from this PR
  • I have updated the documentation (wiki pages, ReadMe etc), if applies

@amiclaus amiclaus self-assigned this Dec 17, 2025
@amiclaus amiclaus force-pushed the staging/ci_sphinx_update branch from ea4fd7e to c1c17cc Compare December 17, 2025 14:15
@amiclaus amiclaus changed the title ci: documentation: exclude drivers/api from README ci: documentation: exclude drivers:api from README Dec 17, 2025
@amiclaus amiclaus requested a review from raezt December 17, 2025 14:19
@raezt
Copy link
Collaborator

raezt commented Dec 17, 2025

@amiclaus Would it make sense to exclude ‘platform’ as well?

Add exclusion mechanism for driver categories that don't require
README.rst files. The drivers:api and drivers:platform folders are
now excluded from the documentation check as they contain interface
files and platform-specific implementations rather than standalone
driver implementations. Additional categories can be easily added
to the excluded_categories array in the future.

Signed-off-by: Antoniu Miclaus <[email protected]>
@amiclaus amiclaus force-pushed the staging/ci_sphinx_update branch from c1c17cc to d8832a4 Compare December 17, 2025 15:43
Copy link
Contributor Author

@amiclaus amiclaus left a comment

Choose a reason for hiding this comment

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

v2: added platform to excluded_categories (@raezt )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants