Skip to content

add uv support#68

Open
timtogan wants to merge 3 commits intomasterfrom
uv
Open

add uv support#68
timtogan wants to merge 3 commits intomasterfrom
uv

Conversation

@timtogan
Copy link
Copy Markdown
Member

@timtogan timtogan commented Apr 1, 2026

No description provided.

Copilot AI review requested due to automatic review settings April 1, 2026 20:44
Copy link
Copy Markdown

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

Adds uv-based dependency management alongside the existing MkDocs documentation build, and documents a uv-based contributor workflow.

Changes:

  • Add pyproject.toml + uv.lock to support uv sync for Python dependencies.
  • Add a “With uv” contributor page and link it into the MkDocs navigation.
  • Add Python tooling niceties (.python-version, expanded .gitignore) for local development.

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
uv.lock Introduces a uv lockfile for reproducible dependency installs.
pyproject.toml Defines project metadata and dependencies for uv-based workflows.
mkdocs.yml Adds nav entry for the new uv contributing guide.
docs/contributing/with-uv.md New contributor documentation for installing/using uv.
.python-version Pins a Python version for local tooling.
.gitignore Ignores common Python build artifacts and .venv.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pyproject.toml Outdated
"python-markdown-math>=0.9",
]


Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

This repository now has two sources of truth for Python dependencies: requirements.txt (used by Read the Docs) and pyproject.toml/uv.lock (used by uv). Without an explicit sync process, these can drift and lead to different builds; consider generating requirements.txt from the lock (or updating RTD to install via uv) to keep environments consistent.

Suggested change
[tool.uv]
# This project uses uv as the single source of truth for dependencies.
# The requirements.txt file used by Read the Docs must be generated from
# the uv lockfile to avoid drift between environments. Regenerate it with:
# uv export --format requirements-txt --output requirements.txt

Copilot uses AI. Check for mistakes.
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