unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: Tomi Ollila <tomi.ollila@iki.fi>
To: fredrik@frelon.se, notmuch@notmuchmail.org
Cc: "Fredrik Lönnegren" <fredrik@frelon.se>
Subject: Re: [PATCH] docs: Update intersphinx_mapping
Date: Sat, 07 Dec 2024 16:19:26 +0200	[thread overview]
Message-ID: <y1yqloi.uhu04x-too@iki.fi> (raw)
In-Reply-To: <20241205164550.2419455-1-fredrik@frelon.se>

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\r

  reply	other threads:[~2024-12-07 14:19 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-05 16:45 [PATCH] docs: Update intersphinx_mapping fredrik
2024-12-07 14:19 ` Tomi Ollila [this message]
2024-12-07 14:23   ` Dan Čermák
2024-12-08 13:13 ` David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=y1yqloi.uhu04x-too@iki.fi \
    --to=tomi.ollila@iki.fi \
    --cc=fredrik@frelon.se \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).