diff --git a/docs/api.rst b/docs/config.rst similarity index 96% rename from docs/api.rst rename to docs/config.rst index e5888d6..d4ab114 100644 --- a/docs/api.rst +++ b/docs/config.rst @@ -1,14 +1,12 @@ -=== -API -=== +============= +Configuration +============= -Config Parameters -================= .. _general_config: General Section ---------------- +=============== :: @@ -49,7 +47,7 @@ General Section .. _pair_config: Pair Section ------------- +============ :: @@ -79,7 +77,7 @@ Pair Section .. _storage_config: Storage Section ---------------- +=============== :: @@ -98,12 +96,12 @@ Storage Section .. _storages: Supported Storages -================== +------------------ .. module:: vdirsyncer.storage Read-write storages -------------------- +~~~~~~~~~~~~~~~~~~~ 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 @@ -118,7 +116,7 @@ wished. .. autoclass:: SingleFileStorage Read-only storages ------------------- +~~~~~~~~~~~~~~~~~~ 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 diff --git a/docs/index.rst b/docs/index.rst index a581742..5d4af6b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ Table of Contents :maxdepth: 1 tutorial - api + config keyring supported troubleshooting