From dd72286bbf05b682997320b22360760ad590946a Mon Sep 17 00:00:00 2001 From: Antoine Nguyen Date: Wed, 6 May 2020 13:41:46 +0200 Subject: [PATCH] Documentation update. --- doc/contributing/getting_started.rst | 11 +++-------- doc/upgrade.rst | 12 ++++++++++++ 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/doc/contributing/getting_started.rst b/doc/contributing/getting_started.rst index 7cfdaccba..e5b841708 100644 --- a/doc/contributing/getting_started.rst +++ b/doc/contributing/getting_started.rst @@ -28,17 +28,12 @@ Prepare a virtual environment ============================= A `virtual environment -`_ is a good way to +`_ is a good way to setup a development environment on your machine. -.. note:: - - ``virtualenv`` is available on all major distributions, just - install it using your favorite packages manager. - To do so, run the following commands:: - $ virtualenv + $ python3 -m venv $ source /bin/activate $ git clone https://github.com/modoboa/modoboa.git $ cd modoboa @@ -119,7 +114,7 @@ If you need to modify the documenation and want to see the result, you can build it as follows: .. sourcecode:: bash - + > tox -e doc > firefox .tox/doc/tmp/html/index.html diff --git a/doc/upgrade.rst b/doc/upgrade.rst index 09e8f5ce3..40b047cf8 100644 --- a/doc/upgrade.rst +++ b/doc/upgrade.rst @@ -91,6 +91,18 @@ Rebuild Virtual Environment Specific instructions ********************* +1.15.0 +====== + +This version drops Python 2 support. + +.. warning:: + + If you upgrade an existing python 2 installation, you will need to + create a new Python 3 virtual environment. You can remove the + existing virtual environment and replace it by the new one so you + won't have to modify your configuration files. + 1.14.0 ======