From 16cbeeee2c8e672808c1cfdb5b98a24138abbea7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Sat, 3 May 2025 17:10:58 +0200 Subject: [PATCH] Use rfc role in documentation and ignore checking datatracker.ietf.org links --- modules/inbound_email/doc/linkcheck_ignore.json | 1 + modules/inbound_email/doc/reference.rst | 3 +-- modules/ldap_authentication/doc/linkcheck_ignore.json | 1 + .../doc/linkcheck_ignore.json | 2 +- trytond/doc/conf.py | 10 ++++++++++ trytond/doc/linkcheck_ignore.json | 1 + trytond/doc/ref/tools/email.rst | 3 ++- 7 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 modules/inbound_email/doc/linkcheck_ignore.json create mode 100644 modules/ldap_authentication/doc/linkcheck_ignore.json create mode 100644 trytond/doc/linkcheck_ignore.json diff --git a/modules/inbound_email/doc/linkcheck_ignore.json b/modules/inbound_email/doc/linkcheck_ignore.json new file mode 100644 index 0000000000..ae86156d83 --- /dev/null +++ b/modules/inbound_email/doc/linkcheck_ignore.json @@ -0,0 +1 @@ +["https://datatracker.ietf.org/*"] diff --git a/modules/inbound_email/doc/reference.rst b/modules/inbound_email/doc/reference.rst index a604fdefb8..bd90f80d16 100644 --- a/modules/inbound_email/doc/reference.rst +++ b/modules/inbound_email/doc/reference.rst @@ -14,8 +14,7 @@ The *Inbound Email Module* defines a route for each `Inbox `_ message. + it is ``raw`` which expect the bytes of a :rfc:`822` message. Other available types: diff --git a/modules/ldap_authentication/doc/linkcheck_ignore.json b/modules/ldap_authentication/doc/linkcheck_ignore.json new file mode 100644 index 0000000000..ae86156d83 --- /dev/null +++ b/modules/ldap_authentication/doc/linkcheck_ignore.json @@ -0,0 +1 @@ +["https://datatracker.ietf.org/*"] diff --git a/modules/web_shop_product_data_feed/doc/linkcheck_ignore.json b/modules/web_shop_product_data_feed/doc/linkcheck_ignore.json index 97a402aa10..42418c7109 100644 --- a/modules/web_shop_product_data_feed/doc/linkcheck_ignore.json +++ b/modules/web_shop_product_data_feed/doc/linkcheck_ignore.json @@ -1 +1 @@ -["https://www.facebook.com/business/*"] +["https://www.facebook.com/business/*", "https://datatracker.ietf.org/*"] diff --git a/trytond/doc/conf.py b/trytond/doc/conf.py index d5b4afe119..c4f32603d7 100644 --- a/trytond/doc/conf.py +++ b/trytond/doc/conf.py @@ -81,4 +81,14 @@ intersphinx_mapping = { } linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*'] +try: + with open(os.path.join( + os.path.dirname(__file__), + 'linkcheck_ignore.json'), 'r') as f: + import json + linkcheck_ignore.extend(json.load(f)) + del json +except FileNotFoundError: + pass + del get_info, info, base_url, modules_url, tryton_url, proteus_url diff --git a/trytond/doc/linkcheck_ignore.json b/trytond/doc/linkcheck_ignore.json new file mode 100644 index 0000000000..ae86156d83 --- /dev/null +++ b/trytond/doc/linkcheck_ignore.json @@ -0,0 +1 @@ +["https://datatracker.ietf.org/*"] diff --git a/trytond/doc/ref/tools/email.rst b/trytond/doc/ref/tools/email.rst index cffdc054bd..e8b8f3112c 100644 --- a/trytond/doc/ref/tools/email.rst +++ b/trytond/doc/ref/tools/email.rst @@ -14,7 +14,8 @@ Email .. function:: format_address(email[, name]) - Return a string suitable for an RFC 2822 From, To or Cc header. + Return a string suitable for an :rfc:`2822` ``From``, ``To`` or ``Cc`` + header. .. function:: validate_email(email)