Skip to content

Conversation

@borchero
Copy link
Member

Motivation

It all started with trying to fix the current warnings in the docs. Turns out that many links in the API docs were broken and the design generally didn't help readability. Hence, this PR just refactors the entire thing.

Changes

  • Use the pydata sphinx theme and take plenty of inspiration from the polars docs setup
  • Manually structure the entire API documentation, introducing semantic grouping of methods
  • Remove all warnings and make doc builds fail on warnings
  • Ensure that pixi run docs always runs a clean build

@borchero borchero self-assigned this Oct 25, 2025
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 25, 2025
@codecov
Copy link

codecov bot commented Oct 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (91961d5) to head (c91c525).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #200   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           53        53           
  Lines         2996      2996           
=========================================
  Hits          2996      2996           

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

@borchero
Copy link
Member Author

@borchero borchero merged commit a030b76 into main Oct 25, 2025
31 checks passed
@borchero borchero deleted the revamp-docs branch October 25, 2025 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants