changeset 784f15644018 in tryton:default
details: https://hg.tryton.org/tryton?cmd=changeset&node=784f15644018
description:
Check links in documentation
issue11409
review390641002
diffstat:
.drone.yml | 1 +
doc/installation.rst | 27 +++++++++++++--------------
2 files changed, 14 insertions(+), 14 deletions(-)
diffs (52 lines):
diff -r 014e162a39b1 -r 784f15644018 .drone.yml
--- a/.drone.yml Tue Apr 19 23:17:51 2022 +0200
+++ b/.drone.yml Mon Apr 25 18:34:07 2022 +0200
@@ -30,6 +30,7 @@
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 -r 014e162a39b1 -r 784f15644018 doc/installation.rst
--- a/doc/installation.rst Tue Apr 19 23:17:51 2022 +0200
+++ b/doc/installation.rst Mon Apr 25 18:34:07 2022 +0200
@@ -4,24 +4,23 @@
Installation
------------
-Once you've downloaded and unpacked a tryton source release, enter the
-directory where the archive was unpacked, and run:
-
-.. code-block:: console
+There are three options to install Tryton:
- $ python setup.py install
+ * 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.
-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.
+ * Install the published package.
+ You first need to have `pip <https://pip.pypa.io/>`_ installed.
+ Then to install ``tryton`` run:
-For advanced options, please refer to the easy_install__ and/or the
-distutils__ documentation:
+ .. code-block:: console
-__ http://setuptools.readthedocs.io/en/latest/easy_install.html
+ $ python -m pip install tryton
-__ http://docs.python.org/inst/inst.html
+ * Without installation, you need to make sure you have all the dependencies
+ installed and then run:
-To use without installation, run :command:`bin/tryton` from where the archive
-was unpacked.
+ .. code-block:: console
+ $ python bin/tryton
