docs(jmap): JMAP usage documentation and autodoc stubs#626
Merged
SashankBhamidi merged 1 commit intofeature/jmapfrom Feb 21, 2026
Merged
docs(jmap): JMAP usage documentation and autodoc stubs#626SashankBhamidi merged 1 commit intofeature/jmapfrom
SashankBhamidi merged 1 commit intofeature/jmapfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the JMAP calendar client support that was introduced in PR #625. The documentation provides user-facing guides and API reference stubs for Sphinx autodoc generation.
Changes:
- Added detailed JMAP usage guide covering authentication, calendar operations, event CRUD, search, sync, tasks, and error handling
- Added autodoc reference stubs for JMAP client and data object modules
- Updated the documentation index to include the new JMAP section
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/source/jmap.rst | Comprehensive 377-line usage guide for JMAP client functionality including quick start, authentication methods, calendar operations, event CRUD, search, incremental sync, task support, async API, error handling, and configuration |
| docs/source/index.rst | Added jmap to the documentation table of contents after the async section |
| docs/source/reference.rst | Added references to caldav/jmap_client and caldav/jmap_objects autodoc stubs |
| docs/source/caldav/jmap_client.rst | Autodoc stub for JMAPClient and AsyncJMAPClient modules |
| docs/source/caldav/jmap_objects.rst | Autodoc stub for JMAP data objects (calendar, event, task) and error classes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
Merging into |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/source/jmap.rstdocs/source/caldav/jmap_client.rstdocs/source/caldav/jmap_objects.rstdocs/source/reference.rstdocs/source/index.rstRelated #625