From da43cb79050fed5e694eb5f2a382344ab4648e14 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/ref/sendmail.rst | 5 ++--- doc/ref/transaction.rst | 3 --- doc/topics/configuration.rst | 6 ++---- doc/topics/install.rst | 6 ------ doc/topics/pyson.rst | 2 +- 6 files changed, 6 insertions(+), 17 deletions(-) diff --git a/.drone.yml b/.drone.yml index 373dcee64b..b45ef267ef 100644 --- a/.drone.yml +++ b/.drone.yml @@ -36,6 +36,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/ref/sendmail.rst b/doc/ref/sendmail.rst index 00308ff612..c5720125bc 100644 --- a/doc/ref/sendmail.rst +++ b/doc/ref/sendmail.rst @@ -8,8 +8,8 @@ Sendmail Send email message only if the current transaction is successfully committed. - The required arguments are an `RFC 822`_ from-address string, a list of `RFC - 822`_ to-address strings (a bare string is treated as a list with 1 + The required arguments are an :rfc:`822` from-address string, a list of + :rfc:`822` to-address strings (a bare string is treated as a list with 1 address), and an email message. The caller may pass a :class:`~trytond.transaction.Transaction` instance to join otherwise the current one is joined. @@ -52,5 +52,4 @@ Sendmail Queue the email message to send. -.. _`RFC 822`: https://tools.ietf.org/html/rfc822.html .. _`smtplib`: https://docs.python.org/2/library/smtplib.html diff --git a/doc/ref/transaction.rst b/doc/ref/transaction.rst index 31d31fe238..291bfa4b7a 100644 --- a/doc/ref/transaction.rst +++ b/doc/ref/transaction.rst @@ -112,8 +112,6 @@ Transaction Register in the transaction a data manager conforming to the `Two-Phase Commit protocol`_. - More information on how to implement such data manager is available at the - `Zope documentation`_. This method returns the registered datamanager. It could be a different yet equivalent (in term of python equality) @@ -128,4 +126,3 @@ Transaction .. _`context manager`: http://docs.python.org/reference/datamodel.html#context-managers .. _`PEP-0249`: https://www.python.org/dev/peps/pep-0249/ .. _`Two-Phase Commit protocol`: https://en.wikipedia.org/wiki/Two-phase_commit_protocol -.. _`Zope documentation`: http://zodb.readthedocs.org/en/latest/transactions.html#the-two-phase-commit-protocol-in-practice diff --git a/doc/topics/configuration.rst b/doc/topics/configuration.rst index f3f4a30dcd..2c8bc42fa9 100644 --- a/doc/topics/configuration.rst +++ b/doc/topics/configuration.rst @@ -112,7 +112,7 @@ Defines how the database is managed. uri ~~~ -Contains the URI to connect to the SQL database. The URI follows the RFC-3986_. +Contains the URI to connect to the SQL database. The URI follows the :rfc:`3986`. The typical form is: database://username:password@host:port/?param1=value1¶m2=value2 @@ -401,7 +401,7 @@ Default: ``smtp://localhost:25`` from ~~~~ -Defines the default ``From`` address (using RFC-822_) for emails sent by Tryton. +Defines the default ``From`` address (using :rfc:`822`) for emails sent by Tryton. For example:: @@ -654,9 +654,7 @@ Example:: .. _JSON-RPC: http://en.wikipedia.org/wiki/JSON-RPC .. _XML-RPC: http://en.wikipedia.org/wiki/XML-RPC -.. _RFC-3986: http://tools.ietf.org/html/rfc3986 .. _SMTP-URL: http://tools.ietf.org/html/draft-earhart-url-smtp-00 -.. _RFC-822: https://tools.ietf.org/html/rfc822 .. _SSL: http://en.wikipedia.org/wiki/Secure_Sockets_Layer .. _STARTTLS: http://en.wikipedia.org/wiki/STARTTLS .. _WSGI middleware: https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface#Specification_overview diff --git a/doc/topics/install.rst b/doc/topics/install.rst index 5cf63c91d9..7847ca17ee 100644 --- a/doc/topics/install.rst +++ b/doc/topics/install.rst @@ -36,9 +36,3 @@ There are three options to install Tryton: You can register modules by linking them into the ``trytond/modules`` folder. - -.. warning:: - Note that you may need administrator/root privileges for this step, as - this command will by default attempt to install trytond to the Python - site-packages directory on your system. -.. diff --git a/doc/topics/pyson.rst b/doc/topics/pyson.rst index 72139bb709..178db9d4f5 100644 --- a/doc/topics/pyson.rst +++ b/doc/topics/pyson.rst @@ -88,7 +88,7 @@ A similar expression in Python looks like this:: 'context' in locals() and isinstance(context, dict) and 'company' in context and '=' or '!=' -.. _if-then-else: http://en.wikipedia.org/wiki/Conditional_statement#If-Then.28-Else.29 +.. _if-then-else: https://en.wikipedia.org/wiki/Conditional_(computer_programming)#If%E2%80%93then(%E2%80%93else) Given the PYSON statement::