diff --git a/CHANGELOG.rst b/CHANGELOG.rst index d6dc71d..54154f6 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -14,6 +14,7 @@ Version 0.19.1 - Fixed crash when operating on Google Contacts. :gh:`994` - The ``HTTP_PROXY`` and ``HTTPS_PROXY`` are now respected. :gh:`1031` +- Various documentation updates. Version 0.19.0 ============== diff --git a/docs/installation.rst b/docs/installation.rst index c7508e5..cf52732 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -55,10 +55,33 @@ way to do this, for example, using Ubuntu:: Then you have several options. The following text applies for most Python software by the way. +pipx: The clean, easy way +~~~~~~~~~~~~~~~~~~~~~~~~~ + +pipx_ is a new package manager for Python-based software that automatically +sets up a virtual environment for each program you install. Assuming you have +it installed on your operating system, you can do:: + + pipx install vdirsyncer + +and ``~/.local/pipx/venvs/vdirsyncer`` will be your new vdirsyncer installation. To +update vdirsyncer to the latest version:: + + pipx upgrade vdirsyncer + +If you're done with vdirsyncer, you can do:: + + pipx uninstall vdirsyncer + +and vdirsyncer will be uninstalled, including its dependencies. + +.. _pipx: https://github.com/pipxproject/pipx + The dirty, easy way ~~~~~~~~~~~~~~~~~~~ -The easiest way to install vdirsyncer at this point would be to run:: +If pipx is not available on your distirbution, the easiest way to install +vdirsyncer at this point would be to run:: pip install --ignore-installed vdirsyncer @@ -92,25 +115,4 @@ This method has two advantages: distro-specific issues. - You can delete ``~/vdirsyncer_env/`` to uninstall vdirsyncer entirely. -The clean, easy way -~~~~~~~~~~~~~~~~~~~ - -pipx_ is a new package manager for Python-based software that automatically -sets up a virtualenv for each program you install. Assuming you have it -installed on your operating system, you can do:: - - pipx install vdirsyncer - -and ``~/.local/pipx/venvs/vdirsyncer`` will be your new vdirsyncer installation. To -update vdirsyncer to the latest version:: - - pipx upgrade vdirsyncer - -If you're done with vdirsyncer, you can do:: - - pipx uninstall vdirsyncer - -and vdirsyncer will be uninstalled, including its dependencies. - .. _virtualenv: https://virtualenv.readthedocs.io/ -.. _pipx: https://github.com/pipxproject/pipx diff --git a/docs/problems.rst b/docs/problems.rst index a90fc02..50ce304 100644 --- a/docs/problems.rst +++ b/docs/problems.rst @@ -18,5 +18,5 @@ package that don't play well with packages assuming a normal ``requests``. This is due to stubbornness on both sides. See :gh:`82` and :gh:`140` for past discussions. You have one option to work -around this, that is, to install vdirsyncer in a virtualenv, see +around this, that is, to install vdirsyncer in a virtual environment, see :ref:`manual-installation`.