Skip to content

Commit f1cc05a

Browse files
committed
fix config parameter formatting
1 parent 6c652c9 commit f1cc05a

File tree

1 file changed

+69
-67
lines changed

1 file changed

+69
-67
lines changed

docs/config.rst

Lines changed: 69 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -161,19 +161,19 @@ CalDAV and CardDAV
161161

162162
::
163163

164-
[storage example_for_caldav]
165-
type = "caldav"
166-
#start_date = null
167-
#end_date = null
168-
#item_types = []
169-
url = "..."
170-
#username = ""
171-
#password = ""
172-
#verify = true
173-
#auth = null
174-
#useragent = "vdirsyncer/0.16.4"
175-
#verify_fingerprint = null
176-
#auth_cert = null
164+
[storage example_for_caldav]
165+
type = "caldav"
166+
#start_date = null
167+
#end_date = null
168+
#item_types = []
169+
url = "..."
170+
#username = ""
171+
#password = ""
172+
#verify = true
173+
#auth = null
174+
#useragent = "vdirsyncer/0.16.4"
175+
#verify_fingerprint = null
176+
#auth_cert = null
177177

178178
You can set a timerange to synchronize with the parameters ``start_date``
179179
and ``end_date``. Inside those parameters, you can use any Python
@@ -223,34 +223,36 @@ CalDAV and CardDAV
223223
CardDAV.
224224

225225
::
226-
[storage example_for_carddav]
227-
type = "carddav"
228-
url = "..."
229-
#username = ""
230-
#password = ""
231-
#verify = true
232-
#auth = null
233-
#useragent = "vdirsyncer/0.16.4"
234-
#verify_fingerprint = null
235-
#auth_cert = null
236-
237-
:param url: Base URL or an URL to an addressbook.
238-
:param username: Username for authentication.
239-
:param password: Password for authentication.
240-
:param verify: Verify SSL certificate, default True. This can also be a
241-
local path to a self-signed SSL certificate. See :ref:`ssl-tutorial`
242-
for more information.
243-
:param verify_fingerprint: Optional. SHA1 or MD5 fingerprint of the
244-
expected server certificate. See :ref:`ssl-tutorial` for more
245-
information.
246-
:param auth: Optional. Either ``basic``, ``digest`` or ``guess``. The
247-
default is preemptive Basic auth, sending credentials even if server
248-
didn't request them. This saves from an additional roundtrip per
249-
request. Consider setting ``guess`` if this causes issues with your
250-
server.
251-
:param auth_cert: Optional. Either a path to a certificate with a client
252-
certificate and the key or a list of paths to the files with them.
253-
:param useragent: Default ``vdirsyncer``.
226+
227+
[storage example_for_carddav]
228+
type = "carddav"
229+
url = "..."
230+
#username = ""
231+
#password = ""
232+
#verify = true
233+
#auth = null
234+
#useragent = "vdirsyncer/0.16.4"
235+
#verify_fingerprint = null
236+
#auth_cert = null
237+
238+
:param url: Base URL or an URL to an addressbook.
239+
:param username: Username for authentication.
240+
:param password: Password for authentication.
241+
:param verify: Verify SSL certificate, default True. This can also be a
242+
local path to a self-signed SSL certificate. See
243+
:ref:`ssl-tutorial` for more information.
244+
:param verify_fingerprint: Optional. SHA1 or MD5 fingerprint of the expected
245+
server certificate. See :ref:`ssl-tutorial` for
246+
more information.
247+
:param auth: Optional. Either ``basic``, ``digest`` or ``guess``. The
248+
default is preemptive Basic auth, sending credentials even if
249+
server didn't request them. This saves from an additional
250+
roundtrip per request. Consider setting ``guess`` if this
251+
causes issues with your server.
252+
:param auth_cert: Optional. Either a path to a certificate with a client
253+
certificate and the key or a list of paths to the files
254+
with them.
255+
:param useragent: Default ``vdirsyncer``.
254256

255257
Google
256258
++++++
@@ -321,9 +323,9 @@ or write anything to it.
321323

322324
Please refer to :storage:`caldav` regarding the ``item_types`` and timerange parameters.
323325

324-
:param token_file: A filepath where access tokens are stored.
325-
:param client_id/client_secret: OAuth credentials, obtained from the Google
326-
API Manager.
326+
:param token_file: A filepath where access tokens are stored.
327+
:param client_id/client_secret: OAuth credentials, obtained from the Google
328+
API Manager.
327329

328330
.. storage:: google_contacts
329331

@@ -337,9 +339,9 @@ or write anything to it.
337339
client_id = "..."
338340
client_secret = "..."
339341

340-
:param token_file: A filepath where access tokens are stored.
341-
:param client_id/client_secret: OAuth credentials, obtained from the Google
342-
API Manager.
342+
:param token_file: A filepath where access tokens are stored.
343+
:param client_id/client_secret: OAuth credentials, obtained from the Google
344+
API Manager.
343345

344346
EteSync
345347
+++++++
@@ -357,37 +359,37 @@ password. Neither are stored.
357359

358360
.. storage:: etesync_contacts
359361

360-
Contacts for etesync.
362+
Contacts for etesync.
361363

362-
::
364+
::
363365

364-
[storage example_for_etesync_contacts]
365-
email = ...
366-
secrets_dir = ...
367-
#server_path = ...
368-
#db_path = ...
366+
[storage example_for_etesync_contacts]
367+
email = ...
368+
secrets_dir = ...
369+
#server_path = ...
370+
#db_path = ...
369371
370-
:param email: The email address of your account.
371-
:param secrets_dir: A directory where vdirsyncer can store the encryption
372-
key and authentication token.
373-
:param server_url: Optional. URL to the root of your custom server.
374-
:param db_path: Optional. Use a different path for the database.
372+
:param email: The email address of your account.
373+
:param secrets_dir: A directory where vdirsyncer can store the encryption
374+
key and authentication token.
375+
:param server_url: Optional. URL to the root of your custom server.
376+
:param db_path: Optional. Use a different path for the database.
375377

376378
.. storage:: etesync_calendars
377379

378-
Calendars for etesync.
380+
Calendars for etesync.
379381

380-
::
382+
::
381383

382-
[storage example_for_etesync_calendars]
383-
email = ...
384-
secrets_dir = ...
385-
#server_path = ...
386-
#db_path = ...
384+
[storage example_for_etesync_calendars]
385+
email = ...
386+
secrets_dir = ...
387+
#server_path = ...
388+
#db_path = ...
387389
388390
:param email: The email address of your account.
389391
:param secrets_dir: A directory where vdirsyncer can store the encryption
390-
key and authentication token.
392+
key and authentication token.
391393
:param server_url: Optional. URL to the root of your custom server.
392394
:param db_path: Optional. Use a different path for the database.
393395

0 commit comments

Comments
 (0)