Add Sphinx documentation and related configuration#9
Merged
DanielAvdar merged 4 commits intomainfrom Apr 10, 2025
Merged
Conversation
Introduce Sphinx for documentation generation, including configuration files, themes, and build scripts. Integrated doc generation into the project workflow and configured Read the Docs for automated deployment. Updated dependencies to include required Sphinx packages. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
This commit introduces a Codecov workflow to track code coverage. It triggers on pull requests, main branch pushes, and manual dispatch. The configuration includes setup for Poetry, pytest coverage, and the Codecov action with error handling. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Replaced Poetry setup with UV toolchain and Make for dependency management and test execution. Improved caching configuration and added Codecov test results action for better coverage reporting. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Replaced 'ml_orchestrator' with 'my_pkg' as a placeholder in the coverage and mypy commands. Added TODO comments to remind updating 'my_pkg' to the actual package name. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduce Sphinx for documentation generation, including configuration files, themes, and build scripts. Integrated doc generation into the project workflow and configured Read the Docs for automated deployment. Updated dependencies to include required Sphinx packages.