From ea7a6becedbbd13e523ffe775a3f99803341fe38 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Mon, 25 Apr 2022 18:34:07 +0200 Subject: [PATCH] Check links in documentation issue11409 review390641002 --- .drone.yml | 1 + doc/installation.rst | 27 +++++++++++++-------------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.drone.yml b/.drone.yml index 7839a4e8d8..221a796b76 100644 --- a/.drone.yml +++ b/.drone.yml @@ -30,6 +30,7 @@ pipeline: commands: - pip install sphinx - python -m sphinx -T -E -W -n -b html doc _build/html + - python -m sphinx -T -E -W -n -b linkcheck doc _build volumes: - cache:/root/.cache diff --git a/doc/installation.rst b/doc/installation.rst index 7b79f2dd2b..d398c5b232 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -4,24 +4,23 @@ Installing tryton Installation ------------ -Once you've downloaded and unpacked a tryton source release, enter the -directory where the archive was unpacked, and run: +There are three options to install Tryton: -.. code-block:: console + * Install the version provided by your operating system distribution. + This is the quickest and recommended option for those who has operating + system that distributes Tryton. - $ python setup.py install + * Install the published package. + You first need to have `pip `_ installed. + Then to install ``tryton`` run: -Note that you may need administrator/root privileges for this step, as -this command will by default attempt to install tryton to the Python -site-packages directory on your system. + .. code-block:: console -For advanced options, please refer to the easy_install__ and/or the -distutils__ documentation: + $ python -m pip install tryton -__ http://setuptools.readthedocs.io/en/latest/easy_install.html + * Without installation, you need to make sure you have all the dependencies + installed and then run: -__ http://docs.python.org/inst/inst.html - -To use without installation, run :command:`bin/tryton` from where the archive -was unpacked. + .. code-block:: console + $ python bin/tryton