Skip to content

docs: add Conda-Forge and Pixi installation options - #98

Merged
mikeqfu merged 4 commits into
masterfrom
docs/conda-forge
Sep 14, 2026
Merged

mikeqfu merged 4 commits into
masterfrom
docs/conda-forge

Conversation

@mikeqfu

@mikeqfu mikeqfu commented Sep 14, 2026

Copy link
Copy Markdown
Owner

Summary

Updates the installation documentation across README.md and Sphinx documentation (installation.rst) to include support for Conda-Forge and Pixi following the publication of pyrcs on conda-forge. Also refreshes locked project dependencies in uv.lock.

Key Changes

  • README update: Added the Conda-Forge version badge and expanded the Installation section with collapsible instructions for uv, pixi, pip and conda (or mamba).
  • Sphinx documentation alignment: Synchronised index.rst and installation.rst in docs/source/ with README.md, ensuring reST heading syntax, underline lengths and code blocks match.
  • Dependency maintenance: Upgraded all pinned dependencies across development groups in uv.lock using uv lock --upgrade.

Verification

  • Built Sphinx documentation locally to verify rendering and ensure no reST compilation warnings:
uv run sphinx-build -b html docs/source docs/build/html
  • Ran test suite and verified environment synchronization:
uv run pytest

@mikeqfu mikeqfu self-assigned this Sep 14, 2026
@mikeqfu mikeqfu added dependencies Pull requests that update a dependency file documentation Issues related to documentation, such as missing, unclear, or incorrect information tests Changes to tests or code coverage maintenance Ongoing maintenance work such as API updates, dependency upgrades, or modernisation. packaging Changes related to Python packaging, distribution, or build configuration. labels Sep 14, 2026
@codecov

codecov Bot commented Sep 14, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.89%. Comparing base (4360419) to head (46692de).

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #98   +/-   ##
=======================================
  Coverage   84.89%   84.89%           
=======================================
  Files          25       25           
  Lines        3629     3629           
  Branches      662      662           
=======================================
  Hits         3081     3081           
  Misses        313      313           
  Partials      235      235           
Flag Coverage Δ
py3.12 84.87% <ø> (-0.03%) ⬇️
py3.13 84.87% <ø> (-0.03%) ⬇️
py3.14 84.89% <ø> (ø)
py3.15 84.87% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

@mikeqfu
mikeqfu merged commit 10c030c into master Sep 14, 2026
12 of 13 checks passed
@mikeqfu
mikeqfu deleted the docs/conda-forge branch September 14, 2026 15:41
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 Issues related to documentation, such as missing, unclear, or incorrect information maintenance Ongoing maintenance work such as API updates, dependency upgrades, or modernisation. packaging Changes related to Python packaging, distribution, or build configuration. tests Changes to tests or code coverage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant