[SashankBhamidi]

Moves development to uv and a Makefile, as calendaring-jmap has it: dependency groups replace the dev and docs extras, uv.lock is tracked, and CI, the release workflow and Read the Docs all run through make. The docs build, link check and Vale move into documentation.yml.

The reference pages are now generated by sphinx-apidoc, the theme is calendaring-jmap's, and Vale follows its setup and fails CI on errors.

Where it differs from calendaring-jmap:

• Targets use uv run, since .venv/bin paths don't work on Windows.
• CI runs make lint, which only checks, instead of make format.
• The docs build on Python 3.13 and 3.14, because Sphinx 9.2 needs 3.13.
• linkcheckbroken fails when sphinx-build does, and Vale's role pattern no longer skips the prose between two roles.

[read-the-docs-community]

Documentation build overview

📚 calendaring-sync | 🛠️ Build #35810944 | 📁 Comparing e5c0ece against latest (1bb9ad2)

  🔍 Preview build  

60 files changed · + 24 added · ± 27 modified · - 9 deleted

+ Added

• reference/api/calendaring_sync.adapters.base.html
• reference/api/calendaring_sync.adapters.caldav.html
• reference/api/calendaring_sync.adapters.html
• reference/api/calendaring_sync.adapters.jmap.html
• reference/api/calendaring_sync.constants.html
• reference/api/calendaring_sync.error.html
• reference/api/calendaring_sync.html
• reference/api/calendaring_sync.objects.change.html
• reference/api/calendaring_sync.objects.change_set.html
• reference/api/calendaring_sync.objects.conflict.html
• and 14 more...

± Modified

• contribute.html
• genindex.html
• index.html
• release.html
• security.html
• _modules/index.html
• explanation/adapters.html
• explanation/design.html
• explanation/when-to-use.html
• how-to/caldav.html
• and 17 more...

- Deleted

• _modules/typing.html
• reference/adapters.html
• reference/constants.html
• reference/errors.html
• reference/objects.html
• reference/replica.html
• reference/session.html
• reference/store.html
• _modules/collections/abc.html

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[SashankBhamidi]

@stevepiercy just tagging you for context, no need to review this one. I ported the calendaring-jmap setup over to calendaring-sync, and it turned into a bit of a journey.

It started on my Windows machine, where none of the make targets would run. The .venv/bin/... paths come out empty there, so make html ended up running "" as the command. I switched everything to uv run, which finds the environment on any platform.

Then I tested linkcheckbroken by putting a broken link on a page on purpose, and the target still passed. Two things were going on. Only grep's exit status counts, so even a crashed sphinx-build passes. And on Windows, sphinx-build colors its output even into a pipe, so grep never matched "broken" anyway. Reading PIPESTATUS and passing --no-color sorted both.

Vale had a quieter one. The TokenIgnores pattern uses .+, so on a line with two roles it skips everything from the first role to the last backtick, prose included. When I changed it to [^\x60]+, three alerts showed up here that had been hidden all along.

A couple more while I was reading the config. The lint job runs make format, which fixes files instead of checking them, so it can never fail. The Read the Docs skip list starts with ., which matches every file, so the skip never actually kicks in. And Jinja drops a template's last newline, so the apidoc templates need a trailing blank line, and then end-of-file-fixer has to leave them alone.

I'll send the same fixes to calendaring-jmap in a PR, and would love your review there.