Skip to content

Docs stage 2#144

Merged
DanielAvdar merged 17 commits intomainfrom
docs
Apr 8, 2025
Merged

Docs stage 2#144
DanielAvdar merged 17 commits intomainfrom
docs

Conversation

@DanielAvdar
Copy link
Owner

Uncommented the deployment step in the CI configuration to activate it. This step uses the sphinx-notes/pages action for documentation deployment.

Uncommented the deployment step in the CI configuration to activate it. This step uses the sphinx-notes/pages action for documentation deployment.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Replaced `sphinx-notes/pages@v3` with `actions/deploy-pages@v4` for the deployment step in the CI pipeline. This ensures compatibility with the updated GitHub Actions and resolves potential deprecation issues. Additional configuration was added to specify the path for documentation.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Introduced a new workflow for building and deploying documentation on PRs and releases. Refined test workflows by adding dedicated isolation and components parsing tests while removing redundancy. Deprecated the standalone `iso_test.yml` workflow as its functionality is included elsewhere.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Changed the deployment path to include the full `docs/source` directory and introduced the `artifact_name` parameter. These adjustments ensure more clarity and consistency in the workflow configuration.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Reorganized the workflow to separate setup, artifact upload, and deployment steps. Updated the paths to align with Sphinx's HTML build output. This enhances readability and ensures proper documentation deployment.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Deleted obsolete files including iso_test.yml, main.py, and .readthedocs.yaml. Updated docs.yml to adjust triggers, removed redundant Mypy step, and enhanced Sphinx configuration with `intersphinx` and dynamic versioning for more efficient documentation management.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
@DanielAvdar DanielAvdar requested a review from Copilot April 7, 2025 13:23
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 7 changed files in this pull request and generated no comments.

Files not reviewed (2)
  • .github/workflows/iso_test.yml: Language not supported
  • .readthedocs.yaml: Language not supported
Comments suppressed due to low confidence (3)

main.py:1

  • The removal of the main block appears unrelated to the documentation deployment changes; please confirm that this removal is intentional.
if __name__ == "__main__":

.github/workflows/parsing-checks.yml:48

  • Using 'continue-on-error: true' in the isolation check job might hide potential issues; please verify that this behavior is intended for your CI process.
continue-on-error: true

.github/workflows/ci.yml:36

  • Consider removing the commented out deployment step to clean up the CI configuration if it is no longer needed.
#-      - id: deployment

Revamped usage documentation with updated examples for components, pipelines, and advanced use cases. Enabled linting for the docs directory in `pyproject.toml` and made minor adjustments to the Sphinx configuration. These updates improve clarity, maintainability, and consistency across the project.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Updated method names to follow Python's private naming convention by using underscores, ensuring better encapsulation and clarity. Adjusted tests, docstrings, and documentation accordingly to reflect these changes.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
@codecov-commenter
Copy link

codecov-commenter commented Apr 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f9463ad) to head (8e035ef).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #144   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           12        12           
  Lines          330       330           
=========================================
  Hits           330       330           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Added internal references to all documentation sections for better navigation. Updated the index file to include separate ToC categories and switched the `master_doc` to "index" in the Sphinx configuration. This improves documentation structure and usability.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Modified `pyproject.toml` to use Sphinx version `8.2.0` or higher for Python 3.11+, while retaining compatibility with earlier Python versions by using Sphinx `7.0.0+`. Updated `poetry.lock

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Revised the documentation to enhance clarity and consistency in the usage guide. Updated installation instructions, refined example explanations, and improved code comments to make the guide more user-friendly and comprehensive.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Refactored phrasing in the introduction to enhance clarity and streamline content. Simplified language and explanations to make key concepts more accessible and aligned with standard documentation practices. Adjusted formatting for consistency and readability.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Adjusted line breaks and formatting in the introduction section of the documentation to enhance clarity. No content changes were made, ensuring consistency with the existing information.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Revised the README to provide a clearer explanation of `ml-orchestrator` features, emphasizing its lightweight design and independence from the Kubeflow Pipelines (KFP) library. Simplified instructions and added notes about the required dependencies for KFP usage.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
@DanielAvdar DanielAvdar requested a review from Copilot April 8, 2025 15:40
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 13 out of 22 changed files in this pull request and generated no comments.

Files not reviewed (9)
  • .github/workflows/iso_test.yml: Language not supported
  • .readthedocs.yaml: Language not supported
  • docs/source/api_reference.rst: Language not supported
  • docs/source/components.rst: Language not supported
  • docs/source/contributing.rst: Language not supported
  • docs/source/environment.rst: Language not supported
  • docs/source/index.rst: Language not supported
  • docs/source/introduction.rst: Language not supported
  • docs/source/usage.rst: Language not supported
Comments suppressed due to low confidence (3)

tests/test_operation.py:42

  • [nitpick] The test is directly invoking the private method '_create_kfp_str', which can lead to fragile tests if internal implementations change. Consider using the public API if one is available.
assert str_func == op._create_kfp_str(component=component1)

tests/test_dummies/test_write_to_file.py:11

  • [nitpick] The test now calls the private method '_write_to_file', exposing internal implementation details. It is advisable to test functionality through the public interface to ensure stability.
fp._write_to_file(file_path, content)

docs/source/conf.py:16

  • [nitpick] The variable 'version' shadows the imported function 'version' from importlib.metadata. Consider renaming the variable (e.g., 'project_version') to avoid confusion.
version = version(project)

Replaced the previous multi-step deployment process with a simplified setup using peaceiris/actions-gh-pages. This change reduces complexity and streamlines the deployment of Sphinx-generated documentation to GitHub Pages.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Updated the GitHub Actions workflow to change 'contents' permission from read to write. This ensures the workflow has adequate permissions to manage content during documentation updates.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Introduce a Read the Docs configuration file to manage documentation builds. Update the GitHub Actions workflow to focus on publishing docs for releases, removing unused GitHub Pages-related steps.

Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
@DanielAvdar DanielAvdar merged commit f4b24b4 into main Apr 8, 2025
21 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