Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added CI for documentation #12

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Added CI for documentation #12

merged 2 commits into from
Oct 31, 2024

Conversation

szmazurek
Copy link
Contributor

Fixes #

Proposed Changes

  • integrate docs deploy CI

Checklist

  • Tests have been run (pytest --cov=. --cov-report=xml) and the result (coverage report -m) has been pasted here for reviewers.
  • CONTRIBUTING guide has been followed.
  • PR is based on the current GaNDLF-Synth main branch.
  • Non-breaking change (does not break existing functionality): provide as many details as possible for any breaking change.
  • Function/class source code documentation added/updated (ensure typing is used to provide type hints, including and not limited to using Optional if a variable has a pre-defined value).
  • Code has been blacked for style consistency and linting.
  • If applicable, version information has been updated in GANDLF/version.py.
  • If adding a git submodule, add to list of exceptions for black styling in pyproject.toml file.
  • Usage documentation has been updated, if appropriate.
  • If customized dependency installation is required (i.e., a separate pip install step is needed for PR to be functional), please ensure it is reflected in all the files that control the CI, namely: python-test.yml.

@szmazurek szmazurek requested a review from a team as a code owner October 31, 2024 18:20
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 31, 2024 •
edited
Loading

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

@sarthakpati sarthakpati changed the title Docs CI Added CI for documentation Oct 31, 2024
@sarthakpati sarthakpati merged commit ba81a72 into mlcommons:main Oct 31, 2024
8 of 9 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sarthakpati sarthakpati sarthakpati approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szmazurek @sarthakpati