diff --git a/README.rst b/README.rst index f7b7e54..1758bc5 100644 --- a/README.rst +++ b/README.rst @@ -57,10 +57,7 @@ Then copy ``example.cfg`` to ``~/.vdirsyncer/config`` and edit it. You can use t `VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will read the config from. -Run ``vdirsyncer --help``. If you experience any problems, consult the `wiki's -troubleshooting page -`_ or create a -new issue. +Run ``vdirsyncer --help``. How to run the tests ==================== diff --git a/docs/index.rst b/docs/index.rst index 2c52b03..3b0754c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,13 @@ -.. vdirsyncer documentation master file, created by - sphinx-quickstart on Sun May 18 21:53:35 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to vdirsyncer's documentation! -====================================== - -Contents: +========== +vdirsyncer +========== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + storages + keyring + troubleshooting + license - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - +.. include:: ../README.rst diff --git a/docs/license.rst b/docs/license.rst new file mode 100644 index 0000000..da117a8 --- /dev/null +++ b/docs/license.rst @@ -0,0 +1,5 @@ +=================== +Credits and License +=================== + +.. include:: ../LICENSE diff --git a/docs/storages.rst b/docs/storages.rst index 494a90e..bbc343a 100644 --- a/docs/storages.rst +++ b/docs/storages.rst @@ -1,6 +1,6 @@ -============ -All storages -============ +================== +Supported storages +================== This page enlists all storages vdirsyncer supports out of the box. diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst new file mode 100644 index 0000000..9d209c0 --- /dev/null +++ b/docs/troubleshooting.rst @@ -0,0 +1,15 @@ +=============== +Troubleshooting +=============== + + - **[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 ssl_verify in your config file, e.g. + ssl_verify: /usr/share/ca-certificates/cacert.org/cacert.org_root.crt. + + - **During sync an error occurs: TypeError: request() got an unexpected keyword + argument 'verify'** + + You need to update your version of requests.