From 27682f130dd6963f552f56d4c64f9e16086121c9 Mon Sep 17 00:00:00 2001 From: Markus Unterwaditzer Date: Tue, 23 Sep 2014 17:37:40 +0200 Subject: [PATCH] Add supported software --- docs/index.rst | 2 +- docs/{server_support.rst => supported.rst} | 27 +++++++++++++++++----- vdirsyncer/storage/dav.py | 6 ++--- 3 files changed, 25 insertions(+), 10 deletions(-) rename docs/{server_support.rst => supported.rst} (76%) diff --git a/docs/index.rst b/docs/index.rst index d5ed776..a581742 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,7 +18,7 @@ Table of Contents tutorial api keyring - server_support + supported troubleshooting changelog vdir diff --git a/docs/server_support.rst b/docs/supported.rst similarity index 76% rename from docs/server_support.rst rename to docs/supported.rst index ca9cfaa..d64890b 100644 --- a/docs/server_support.rst +++ b/docs/supported.rst @@ -1,10 +1,25 @@ -============== -Server Support -============== +================== +Supported software +================== + +Clients supporting vdir +======================= + +- `khal `_, a calendar application. + +- `vdirsyncer `_, a syncronization + framework and program. + +- `The ppl addressbook `_ uses a similar enough + storage format. There are some pitfalls though, `see the notes on the related + issue `_. + +Supported servers +================= vdirsyncer is currently regularly and automatically tested against the latest versions of Radicale and ownCloud. In principle, vdirsyncer is supposed to run -correctly with any remotely popular CalDAV or CardDAV server. +correctly with any remotely popular CalDAV or CardDAV server. vdirsyncer's synchronization works best if the items have ``UID`` properties. Items which don't have this property still should be synchronized fine as of @@ -13,7 +28,7 @@ exception than the rule. For a possible way to automatically fix such items, take a look at `vfix `_. Radicale -======== +-------- Vdirsyncer is tested against the git version and the latest PyPI release of Radicale. @@ -38,7 +53,7 @@ Radicale. support. ownCloud -======== +-------- Vdirsyncer is tested against the latest version of ownCloud. diff --git a/vdirsyncer/storage/dav.py b/vdirsyncer/storage/dav.py index 17bdf96..bcf4c2a 100644 --- a/vdirsyncer/storage/dav.py +++ b/vdirsyncer/storage/dav.py @@ -215,9 +215,9 @@ class DavStorage(Storage): ''' .. note:: - Please also see :doc:`server_support` for very important information, - as changing some of the default options might be very dangerous with - some servers. + Please also see :doc:`supported` for very important information, as + changing some of the default options might be very dangerous with some + servers. :param url: Base URL or an URL to a collection. :param username: Username for authentication.