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

More doc cleanup

Browse source
This commit is contained in:
Markus Unterwaditzer 2014-05-18 22:58:07 +02:00
parent 9d5be79cf5
commit eb5afdff86
5 changed files with 33 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.rst
View file

@ -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 `VDIRSYNCER_CONFIG` environment variable to change the path vdirsyncer will
read the config from. read the config from.
Run ``vdirsyncer --help``. If you experience any problems, consult the `wiki's Run ``vdirsyncer --help``.
troubleshooting page
<https://github.com/untitaker/vdirsyncer/wiki/Troubleshooting>`_ or create a
new issue.
How to run the tests How to run the tests
==================== ====================

27
docs/index.rst
View file

@ -1,22 +1,13 @@
.. vdirsyncer documentation master file, created by ==========
sphinx-quickstart on Sun May 18 21:53:35 2014. vdirsyncer
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:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 1
storages
keyring
troubleshooting
license
.. include:: ../README.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

5
docs/license.rst Normal file
View file

@ -0,0 +1,5 @@
===================
Credits and License
===================
.. include:: ../LICENSE

6
docs/storages.rst
View file

@ -1,6 +1,6 @@
============ ==================
All storages Supported storages
============ ==================
This page enlists all storages vdirsyncer supports out of the box. This page enlists all storages vdirsyncer supports out of the box.

15
docs/troubleshooting.rst Normal file
View file

@ -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.