sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-04-27 14:57:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Rename "API" to "Config"

Browse source 
This is not actually a programming interface.
This commit is contained in:
Markus Unterwaditzer 2014-10-08 20:32:50 +02:00
parent 0441fe7354
commit 8bb25e3fb2
2 changed files with 10 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/api.rst → docs/config.rst
View file

@ -1,14 +1,12 @@
=== =============
API Configuration
=== =============
Config Parameters
=================
.. _general_config: .. _general_config:
General Section General Section
--------------- ===============
:: ::
@ -49,7 +47,7 @@ General Section
.. _pair_config: .. _pair_config:
Pair Section Pair Section
------------ ============
:: ::
@ -79,7 +77,7 @@ Pair Section
.. _storage_config: .. _storage_config:
Storage Section Storage Section
--------------- ===============
:: ::
@ -98,12 +96,12 @@ Storage Section
.. _storages: .. _storages:
Supported Storages Supported Storages
================== ------------------
.. module:: vdirsyncer.storage .. module:: vdirsyncer.storage
Read-write storages Read-write storages
------------------- ~~~~~~~~~~~~~~~~~~~
These storages generally support reading and changing of their items. Their These storages generally support reading and changing of their items. Their
default value for ``read_only`` is ``False``, but can be set to ``True`` if default value for ``read_only`` is ``False``, but can be set to ``True`` if
@ -118,7 +116,7 @@ wished.
.. autoclass:: SingleFileStorage .. autoclass:: SingleFileStorage
Read-only storages Read-only storages
------------------ ~~~~~~~~~~~~~~~~~~
These storages don't support writing of their items, consequently ``read_only`` These storages don't support writing of their items, consequently ``read_only``
is set to ``True`` by default. Changing ``read_only`` to ``False`` on them is set to ``True`` by default. Changing ``read_only`` to ``False`` on them

2
docs/index.rst
View file

@ -16,7 +16,7 @@ Table of Contents
:maxdepth: 1 :maxdepth: 1
tutorial tutorial
api config
keyring keyring
supported supported
troubleshooting troubleshooting