Skip to content

Initial docgen action#6

Merged
james-bruten-mo merged 7 commits intoMetOffice:mainfrom
yaswant:ci
Oct 2, 2025
Merged

Initial docgen action#6
james-bruten-mo merged 7 commits intoMetOffice:mainfrom
yaswant:ci

Conversation

@yaswant
Copy link
Collaborator

@yaswant yaswant commented Oct 1, 2025

PR Summary

Code Reviewer: @james-bruten-mo

Code Quality Checklist

(Some checks are automatically carried out via the CI pipeline)

  • I have performed a self-review of my own code
  • My code follows the project's style guidelines
  • Comments have been included that aid undertanding and enhance the
    readability of the code
  • My changes generate no new warnings

Testing

  • I have tested this change locally, using the rose-stem suite
  • If any tests fail (rose-stem or CI) the reason is understood and
    acceptable (eg. kgo changes)
  • I have added tests to cover new functionality as appropriate (eg. system
    tests, unit tests, etc.)

trac.log

Security Considerations

  • This change does not introduce security vulnerabilities
  • I have reviewed the code for potential security issues
  • Sensitive data is properly handled (if applicable)
  • Authentication and authorisation are properly implemented (if applicable)

Performance Impact

  • Performance of the code has been considered and, if applicable, suitable
    performance measurements have been conducted

Contributor License Agreement (CLA)

AI Assistance and Attribution

  • Some of the content of this change has been produced with the assistance
    of Generative AI tool name (e.g., Met Office Github Copilot Enterprise,
    Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the
    Simulation Systems AI policy (including
    attribution labels)

Documentation

  • Where appropriate I have updated documentation related to this change and
    confirmed that it builds correctly

Code Review

  • All dependencies have been resolved
  • Related Issues are properly linked and addressed
  • CLA compliance is confirmed
  • Code quality standards are met
  • Tests are adequate and passing
  • Documentation is complete and accurate
  • Security considerations have been addressed
  • Performance impact is acceptable

@yaswant yaswant self-assigned this Oct 1, 2025
@yaswant
Copy link
Collaborator Author

yaswant commented Oct 1, 2025

Note: The docs does not comply with pydata theme, but lets get this in first and then we can update the sphinx configuration in a separate PR

@james-bruten-mo james-bruten-mo merged commit 4c2e0a9 into MetOffice:main Oct 2, 2025
4 checks passed
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.

2 participants