Skip to content

Apply automated docs & notebooks freshness + normalization checks#3232

Merged
C-Achard merged 2 commits intocy/automated-docs&nb-reportfrom
cy/docs-nbs-check-apply
Mar 19, 2026
Merged

Apply automated docs & notebooks freshness + normalization checks#3232
C-Achard merged 2 commits intocy/automated-docs&nb-reportfrom
cy/docs-nbs-check-apply

Conversation

@C-Achard
Copy link
Copy Markdown
Collaborator

@C-Achard C-Achard commented Mar 6, 2026

Applies the --write option of the scripts added in #3228.

⚠️ NOTE: instructions regarding the special metadata commit format have to be followed for this to work.

Checks

  • .md files only show frontmatter edits
  • .ipnyb files are intact
    • nbformatted notebooks render correctly/are not broken
    • Non-nbformatted notebooks only show metadata field edits

@C-Achard C-Achard added this to the CI Overhaul milestone Mar 6, 2026
@C-Achard C-Achard self-assigned this Mar 6, 2026
@C-Achard C-Achard added enhancement New feature or request COLAB Jupyter related to jupyter notebooks documentation documentation updates/comments CI Related to CI/CD jobs and automated testing labels Mar 6, 2026
@deruyter92 deruyter92 self-requested a review March 9, 2026 09:00
@C-Achard C-Achard force-pushed the cy/docs-nbs-check-apply branch from b223e50 to b7e30c8 Compare March 17, 2026 10:32
@C-Achard C-Achard force-pushed the cy/docs-nbs-check-apply branch from 719206c to c2e519d Compare March 17, 2026 12:48
Copy link
Copy Markdown
Member

@MMathisLab MMathisLab left a comment

Choose a reason for hiding this comment

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

lgtm!

@C-Achard C-Achard merged commit f41946f into cy/automated-docs&nb-report Mar 19, 2026
1 check passed
@C-Achard C-Achard deleted the cy/docs-nbs-check-apply branch March 19, 2026 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Related to CI/CD jobs and automated testing COLAB documentation documentation updates/comments enhancement New feature or request Jupyter related to jupyter notebooks

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants