Re: [PATCH] docs: Update intersphinx_mapping

Subject: Re: [PATCH] docs: Update intersphinx_mapping

Date: Sat, 07 Dec 2024 16:19:26 +0200

To: fredrik@frelon.se, notmuch@notmuchmail.org

Cc: Fredrik Lönnegren

From: Tomi Ollila


On Thu, Dec 05 2024, fredrik@frelon.se wrote:

> From: Fredrik Lönnegren <fredrik@frelon.se>
>
> Running `make dirhtml` in bindings/python/docs generates the following
> error:
>
> ```
> sphinx-build -b dirhtml -d build/doctrees   source build/dirhtml
> Running Sphinx v8.0.2
> loading translations [en]... done
> making output directory... done
> Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
> ERROR: Invalid value `None` in intersphinx_mapping['https://docs.python.org/']. Expected a two-element tuple or list.
> ```
>
> This commit updates intersphinx_mapping to follow the latest docs [1]

Looks good to me, I did not follow [1] (nor tested, too lazy for that), but 
did look some random links which also showed the same syntax as in this
change.

Is it so that the line has never been exercised -- or has the current
syntax worked before..?

Tomi

>
> [1] https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
>
> Signed-off-by: Fredrik Lönnegren <fredrik@frelon.se>
> ---
>  bindings/python/docs/source/conf.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/bindings/python/docs/source/conf.py b/bindings/python/docs/source/conf.py
> index 8b43c5ca3f9f..bd4c8b17d94f 100644
> --- a/bindings/python/docs/source/conf.py
> +++ b/bindings/python/docs/source/conf.py
> @@ -206,4 +206,4 @@ latex_documents = [
>  
>  
>  # Example configuration for intersphinx: refer to the Python standard library.
> -intersphinx_mapping = {'https://docs.python.org/': None}
> +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
> -- 
> 2.47.1
>
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: