diff --git a/docs/api.rst b/docs/api.rst index e6afe77..c1139d8 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -11,24 +11,26 @@ General Section --------------- :: + [general] status_path = ... #processes = 0 - - ``status_path``: A directory where vdirsyncer will store metadata for the - next sync. The data is needed to determine whether a new item means it has - been added on one side or deleted on the other. - - ``processes``: Optional, defines the amount of maximal connections to use - for syncing. By default there is no limit, which means vdirsyncer will try - to open a connection for each collection to be synced. The value ``0`` is - ignored. Setting this to ``1`` will only synchronize one collection at a - time. - - While this often greatly increases performance, you might have valid reasons - to set this to a smaller number. For example, your DAV server running on a - Raspberry Pi is so slow that multiple connections don't help much, since the - CPU and not the network is the bottleneck. +- ``status_path``: A directory where vdirsyncer will store metadata for the + next sync. The data is needed to determine whether a new item means it has + been added on one side or deleted on the other. + +- ``processes``: Optional, defines the amount of maximal connections to use for + syncing. By default there is no limit, which means vdirsyncer will try to + open a connection for each collection to be synced. The value ``0`` is + ignored. Setting this to ``1`` will only synchronize one collection at a + time. + + While this often greatly increases performance, you might have valid reasons + to set this to a smaller number. For example, your DAV server running on a + Raspberry Pi is so slow that multiple connections don't help much, since the + CPU and not the network is the bottleneck. .. _pair_config: @@ -36,17 +38,18 @@ Pair Section ------------ :: + [pair pair_name] a = ... b = ... #conflict_resolution = ... - - ``a`` and ``b`` reference the storages to sync by their names. +- ``a`` and ``b`` reference the storages to sync by their names. - - ``conflict_resolution``: Optional, define how conflicts should be handled. - A conflict occurs when one item changed on both sides since the last sync. - Valid values are ``a wins`` and ``b wins``. By default, vdirsyncer will - show an error and abort the synchronization. +- ``conflict_resolution``: Optional, define how conflicts should be handled. A + conflict occurs when one item changed on both sides since the last sync. + Valid values are ``a wins`` and ``b wins``. By default, vdirsyncer will show + an error and abort the synchronization. .. _storage_config: @@ -54,12 +57,13 @@ Storage Section --------------- :: + [storage storage_name] type = ... - - ``type`` defines which kind of storage is defined. See :ref:`storages`. +- ``type`` defines which kind of storage is defined. See :ref:`storages`. - - Any further parameters are passed on to the storage class. +- Any further parameters are passed on to the storage class. .. _storages: diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst index 2ea39a2..468e5b3 100644 --- a/docs/troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -2,15 +2,15 @@ Troubleshooting =============== - - **[Errno 185090050] _ssl.c:343: error:0B084002:x509 certificate - routines:X509_load_cert_crl_file:system lib** +- **[Errno 185090050] _ssl.c:343: error:0B084002:x509 certificate + routines:X509_load_cert_crl_file:system lib** - vdirsyncer cannot find the path to your certificate bundle, you need to - supply it as a parameter to ``verify`` in your config file, e.g.:: + vdirsyncer cannot find the path to your certificate bundle, you need to + supply it as a parameter to ``verify`` in your config file, e.g.:: - verify = /usr/share/ca-certificates/cacert.org/cacert.org_root.crt + verify = /usr/share/ca-certificates/cacert.org/cacert.org_root.crt - - **During sync an error occurs: TypeError: request() got an unexpected keyword - argument 'verify'** +- **During sync an error occurs: TypeError: request() got an unexpected keyword + argument 'verify'** - You need to update your version of requests. + You need to update your version of requests. diff --git a/docs/tutorial.rst b/docs/tutorial.rst index d3ac89c..b09ca9b 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -5,11 +5,11 @@ Tutorial Installation ============ - - Make sure you have Python 2.7+ or Python 3.3+ installed. +- Make sure you have Python 2.7+ or Python 3.3+ installed. - - ``pip install --user vdirsyncer``. +- ``pip install --user vdirsyncer``. - - Check if the ``vdirsyncer`` command is available. +- Check if the ``vdirsyncer`` command is available. Configuration ============= @@ -69,14 +69,14 @@ But what if we want to synchronize multiple addressbooks from the same server? Of course we could create new pairs and storages for each addressbook, but that is very tedious to do. Instead we will use a shortcut: - - Remove the last segment from the URL, so that it ends with ``.../bob/`` - instead of ``.../bob/default/``. +- Remove the last segment from the URL, so that it ends with ``.../bob/`` + instead of ``.../bob/default/``. - - Add the following line to the *pair* section:: - - [pair my_contacts] - ... - collections = default,work +- Add the following line to the *pair* section:: + + [pair my_contacts] + ... + collections = default,work This will synchronize ``https://owncloud.example.com/remote.php/carddav/addressbooks/bob/default/`` diff --git a/vdirsyncer/storage/http.py b/vdirsyncer/storage/http.py index 681f3ac..5190ed3 100644 --- a/vdirsyncer/storage/http.py +++ b/vdirsyncer/storage/http.py @@ -60,7 +60,6 @@ class HttpStorage(Storage): A simple example:: - # HTTP CALENDAR [pair holidays] a = holidays_local b = holidays_remote