Skip to content

Docs improved and using uv to manage python env#32

Merged
OwenYou merged 10 commits intomainfrom
dev
Oct 21, 2025
Merged

Docs improved and using uv to manage python env#32
OwenYou merged 10 commits intomainfrom
dev

Conversation

@WheheoHu
Copy link
Collaborator

No description provided.

@WheheoHu WheheoHu requested review from OwenYou and Copilot October 20, 2025 06:26
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.

Pull Request Overview

This pull request modernizes the project's Python environment management by migrating from pip to uv, consolidates configuration into pyproject.toml, and significantly improves documentation structure and clarity.

Key Changes:

  • Migrated dependency management from pip to uv for faster and more reliable workflows
  • Consolidated all project metadata and configuration into pyproject.toml
  • Restructured and simplified documentation with improved navigation and examples

Reviewed Changes

Copilot reviewed 13 out of 15 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
setup.py Simplified to minimal backward-compatible wrapper for pyproject.toml-based setup
pytest.ini Removed; configuration moved to pyproject.toml
pyproject.toml Created comprehensive project configuration including metadata, dependencies, and tool settings
docs/installation.rst Updated with uv installation instructions and improved structure
docs/index.rst Removed :titlesonly: directives for better navigation
docs/conf.py Added dynamic version reading from pyproject.toml and updated sidebar configuration
docs/api/error.rst Updated exception class names from Dftt* prefix to DFTT* prefix
docs/api/dftt_timerange.rst Simplified by removing redundant method listings and updated module reference
docs/api/dftt_timecode.rst Simplified by removing redundant method listings and updated module reference
dftt_timecode/init.py Implemented dynamic version reading from package metadata
README.md Completely restructured with modern formatting, clearer examples, and bilingual content
.github/workflows/publish-to-pypi.yml Updated to use uv for building packages
.github/workflows/docs.yml Updated to use uv and changed runner to macos-latest

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@OwenYou OwenYou merged commit 842e19a into main Oct 21, 2025
2 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.

3 participants