From: Daniele Varrazzo Date: Sat, 21 Sep 2024 20:16:15 +0000 (+0200) Subject: docs(install): reorganise install page disclaimer X-Git-Tag: 3.2.3~7 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=af5bfa0ec2690571033e38205a98cfc8c6287134;p=thirdparty%2Fpsycopg.git docs(install): reorganise install page disclaimer Show first the happy path and a GOTO usage, then all the possible reasons why you are unhappy. (I just learned that this is referred to as the Anna Karenina principle). --- diff --git a/docs/basic/install.rst b/docs/basic/install.rst index 2b7ad97c9..9fa19ee75 100644 --- a/docs/basic/install.rst +++ b/docs/basic/install.rst @@ -62,6 +62,21 @@ This will install a self-contained package with all the libraries needed. **You will need pip 20.3 at least**: please run ``pip install --upgrade pip`` to update it beforehand. +.. seealso:: + + Did Psycopg 3 install ok? Great! You can now move on to the :ref:`basic + module usage ` to learn how it works. + + Keep on reading if the above method didn't work and you need a different + way to install Psycopg 3. + + For further information about the differences between the packages see + :ref:`pq-impl`. + +If your platform is not supported, or if the libpq packaged is not suitable, +you should proceed to a :ref:`local installation ` or a +:ref:`pure Python installation `. + .. note:: Binary packages are produced on a best-effort basis; the supported @@ -83,30 +98,14 @@ to update it beforehand. .. warning:: - Starting from Psycopg 3.1.20, ARM64 macOS binary packages (i.e. for - Apple M1 machines) are no more available for macOS versions before 14.0. - Please upgrade your OS to at least 14.0 or use a :ref:`local - ` or a :ref:`Python ` - installation. + - Starting from Psycopg 3.1.20, ARM64 macOS binary packages (i.e. for + Apple M1 machines) are no more available for macOS versions before 14.0. + Please upgrade your OS to at least 14.0 or use a :ref:`local + ` or a :ref:`Python ` + installation. -If your platform is not supported, or if the libpq packaged is not suitable, -you should proceed to a :ref:`local installation ` or a -:ref:`pure Python installation `. - -.. seealso:: - - Did Psycopg 3 install ok? Great! You can now move on to the :ref:`basic - module usage ` to learn how it works. - - Keep on reading if the above method didn't work and you need a different - way to install Psycopg 3. - - For further information about the differences between the packages see - :ref:`pq-impl`. - -.. warning:: + - The binary installation is not supported by PyPy. - The binary installation is not supported by PyPy. .. _local-installation: