You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Usage of canonical RFC-links and :rfc:-references in the documentation. Fixes#635
Added a missing v3-migration documentation and some other minor docfixes.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ Contributions are mostly welcome. If the length of this text scares you, then I
4
4
5
5
## Usage of AI and other tools
6
6
7
-
A separate [AI POLICY](AI-POLICY.md) has been made. The gist of it, be transparent and inform if your contribution was a result of clever tool usage and/or AI-usage, don't submit code if you don't understand the code yourself, and you are supposed to contribute value to the project. If you're too lazy to read the AI Policy, then at least have a chat with the AI to work out if your contribution is within the policy or not.
7
+
A separate [AI POLICY](AI-POLICY.md) has been made. If you want to use AI and you're too lazy to read the AI Policy, then at least ask the AI to read it and chat with it to work out if your contribution is within the policy or not.
Copy file name to clipboardExpand all lines: docs/source/about.rst
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,40 +65,40 @@ Support for Python2 was officially not supported starting from caldav
65
65
version 1.0.
66
66
67
67
68
-
RFC 4791, 2518, 5545, 6638 et al
69
-
--------------------------------
68
+
RFC compliance
69
+
--------------
70
70
71
-
RFC 4791 (CalDAV) outlines the standard way of communicating with a
72
-
calendar server. RFC 4791 is an extension of RFC 4918 (WebDAV). The
73
-
scope of this library is basically to cover RFC 4791/4918, the actual
71
+
:rfc:`4791` (CalDAV) outlines the standard way of communicating with a
72
+
calendar server. :rfc:`4791` is an extension of :rfc:`4918` (WebDAV). The
73
+
scope of this library is basically to cover :rfc:`4791` and :rfc:`4918`, the actual
74
74
communication with the caldav server. (The WebDAV standard also has
75
75
quite some extensions, this library supports some of the relevant
76
76
extensions as well).
77
77
78
-
There exists another library webdavclient3 for handling RFC 4918
78
+
There exists another library webdavclient3 for handling :rfc:`4918`
79
79
(WebDAV), ideally we should be depending on it rather than overlap it.
80
80
81
-
RFC 6638/RFC 6047 is extending the CalDAV and iCalendar protocols for
82
-
scheduling purposes, work is in progress to support RFC 6638. Support
83
-
for RFC 6047 is considered mostly outside the scope of this library,
81
+
:rfc:`6638` and :rfc:`6047` extend the CalDAV and iCalendar protocols for
82
+
scheduling purposes, work is in progress to support :rfc:`6638`. Support
83
+
for :rfc:`6047` is considered mostly outside the scope of this library,
84
84
though for convenience this library may contain methods like accept()
85
85
on a calendar invite (which involves fetching the invite from the
86
86
server, editing the calendar data and putting it to the server).
87
87
88
88
This library should make it trivial to fetch an event, modify the data
89
89
and save it back to the server - but to do that it's also needed to
90
-
support RFC 5545 (icalendar). It's outside the scope of this library
91
-
to implement logic for parsing and modifying RFC 5545, instead we
90
+
support :rfc:`5545` (icalendar). It's outside the scope of this library
91
+
to implement logic for parsing and modifying :rfc:`5545`, instead we
92
92
depend on another library for that.
93
93
94
-
RFC 5545 describes the icalendar format. Constructing or parsing
94
+
:rfc:`5545` describes the icalendar format. Constructing or parsing
95
95
icalendar data was considered out of the scope of this library, but we
96
96
do make exceptions - like, there is a method to complete a task - it
97
97
involves editing the icalendar data, and now the ``add_event``,
98
98
``add_todo`` and ``add_journal`` methods are able to construct icalendar
99
99
data if needed.
100
100
101
-
There exists two libraries supporting RFC 5545, vobject and icalendar.
101
+
There exists two libraries supporting :rfc:`5545`, vobject and icalendar.
102
102
vobject was unmaintained for several years, but seems to be actively
103
103
maintained now. The caldav library originally came with vobject
104
104
support, but as many people requested the vobject dependency to be
@@ -109,7 +109,7 @@ Misbehaving server implementations
109
109
----------------------------------
110
110
111
111
Some server implementations may have some "caldav"-support that either
112
-
doesn't implement all of RFC 4791, breaks the standard a bit, or has
112
+
doesn't implement all of :rfc:`4791`, breaks the standard a bit, or has
113
113
extra features. As long as it doesn't add too much complexity to the
114
114
code, hacks and workarounds for "badly behaving caldav servers" are
115
115
considered to be within the scope. Ideally, users of the caldav
@@ -253,7 +253,7 @@ Server-specific highlights
253
253
VTODOs must be stored in a calendar explicitly created for the ``VTODO``
254
254
component type.
255
255
256
-
* **Calendar creation** is not mandatory under RFC 4791. Most self-hosted
256
+
* **Calendar creation** is not mandatory under :rfc:`4791`. Most self-hosted
257
257
servers support it; Google's CalDAV adapter does not.
258
258
259
259
* **Recurring events and tasks** are non-trivial to implement correctly on
@@ -263,7 +263,7 @@ Server-specific highlights
263
263
Some notes on CalDAV URLs
264
264
=========================
265
265
266
-
From v2.1, well-known URLs were hard-coded into the compatibility_hints. As of v2.2, auto-detection based on RFC6764 is supported. This protocol is widely used. For servers supporting it, it's sufficient to add something like "demo2.nextcloud.com" in the URL. For well-known calendar providers, it's not needed to enter anything in the URL, it suffices to put i.e. `features="ecloud"` into the connection parameters.
266
+
From v2.1, well-known URLs were hard-coded into the compatibility_hints. As of v2.2, auto-detection based on :rfc:`6764` is supported. This protocol is widely used. For servers supporting it, it's sufficient to add something like "demo2.nextcloud.com" in the URL. For well-known calendar providers, it's not needed to enter anything in the URL, it suffices to put i.e. `features="ecloud"` into the connection parameters.
267
267
268
268
CalDAV URLs can be quite confusing, some software requires the URL to the calendar, other requires the URL to the principal. The Python CalDAV library does support accessing calendars and principals using such URLs, but the recommended practice is to configure up the CalDAV root URL and tell the library to find the principal and calendars from that. Typical examples of CalDAV URLs:
0 commit comments