Skip to content

Conversation

@amrit110
Copy link
Member

@amrit110 amrit110 commented Dec 16, 2025

This pull request makes a comprehensive migration from Poetry to uv for dependency management, updates the development and documentation workflows to use uv and MkDocs, and modernizes the documentation structure and build process. It removes legacy Sphinx and Poetry configurations, updates CI/CD pipelines, and provides clearer developer instructions.

The most important changes are:

Dependency Management and Development Workflow

  • Migrated all development and CI workflows from Poetry to uv, including updating the documentation, contributing guides, and pre-commit hooks to reference uv commands and lock files instead of Poetry. (CONTRIBUTING.MD, docs/contributing.md, .pre-commit-config.yaml, .python-version) [1] [2] [3] [4]

Continuous Integration and Deployment

  • Rewrote all GitHub Actions workflows (tests.yaml, smoke_tests.yaml, static_code_checks.yaml, publish_and_release.yml) to use uv for dependency installation, environment setup, and running scripts/tests, removing all Poetry-related steps and caches. [1] [2] [3] [4] [5] [6] [7]
  • Added a new unified documentation workflow .github/workflows/docs.yml for building and deploying docs with uv and MkDocs, and removed legacy Sphinx-based workflows (docs_build.yml, docs_publish.yml). [1] [2] [3]

Documentation System Modernization

  • Transitioned documentation from Sphinx to MkDocs, including removing Sphinx-specific files (docs/Makefile), updating the documentation structure, and adding new guides for building and serving docs locally with uv and MkDocs. (docs/README.md, docs/api.md, docs/examples/index.md) [1] [2] [3] [4]
  • Updated documentation configuration references to point to mkdocs.yml and clarified the directory structure and build instructions.

General Cleanup

  • Removed obsolete Sphinx and Poetry references and files throughout the repository to ensure consistency with the new uv-based workflow. [1] [2] [3]

These changes collectively modernize the project's developer experience, streamline CI/CD, and make documentation easier to build and maintain.

@amrit110 amrit110 requested a review from lotif December 16, 2025 21:26
@amrit110 amrit110 self-assigned this Dec 16, 2025
@amrit110 amrit110 added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Dec 16, 2025
@amrit110 amrit110 marked this pull request as draft December 16, 2025 21:26
@codecov
Copy link

codecov bot commented Dec 16, 2025

Codecov Report

❌ Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 79.66%. Comparing base (3f7ba24) to head (98000bb).

Files with missing lines Patch % Lines
fl4health/reporting/wandb_reporter.py 50.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main     #474   +/-   ##
=======================================
  Coverage   79.66%   79.66%           
=======================================
  Files         166      166           
  Lines       10553    10553           
=======================================
  Hits         8407     8407           
  Misses       2146     2146           

☔ 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.

@amrit110 amrit110 marked this pull request as ready for review December 16, 2025 22:11
@amrit110 amrit110 requested a review from emersodb December 16, 2025 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants