Skip to content

Conversation

@ederjc
Copy link
Member

@ederjc ederjc commented Mar 26, 2025

Description of Change

This adds a reusable workflow for build checking of docs for repos using Sphinx and this folder structure:

docs/
  requirements.txt
  Makefile
  ...

and can be called from any repository using (for example):

 name: Build docs
 on:
  ...
 jobs:
  call-workflow:
    uses: Infineon/makers-devops/.github/workflows/docs_build.yml@main

Workflow Test

Tested here: Infineon/arduino-core-psoc6#81

Checklist

Remove items that do not apply. For completed items, change [ ] to [x].

  • PR description included and stakeholders cc'd
  • All tests pass
  • Tests are changed or added
  • Relevant documentation, tutorials, templates and examples are changed or added
  • PR release notes describe the change in a way relevant to developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Please add a concise description for developers to read in the release notes, or 'none' if notes are not relevant to developers.

jaenrig-ifx
jaenrig-ifx previously approved these changes Mar 26, 2025
Copy link
Member

@jaenrig-ifx jaenrig-ifx left a comment

Choose a reason for hiding this comment

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

Nice :D

@ederjc ederjc merged commit 171045c into main Mar 31, 2025
6 checks passed
@ederjc ederjc deleted the feature/docs-build-check branch July 2, 2025 04:19
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