From: Jani Nikula <jani@nikula.org>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: Re: [PATCH] doc: fix man page build for Sphinx 4.x
Date: Wed, 19 May 2021 08:45:19 +0300 [thread overview]
Message-ID: <87h7iznuog.fsf@nikula.org> (raw)
In-Reply-To: <87cztny64r.fsf@tethera.net>
On Tue, 18 May 2021, David Bremner <david@tethera.net> wrote:
> Jani Nikula <jani@nikula.org> writes:
>
>>
>> The Sphinx documentation on this [1] is confusing, and has the change
>> backwards. Git history says the default changed from False to True.
>>
>> [1] https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-man_make_section_directory
>
> Maybe the docs were corrected?
>
> Changed in version 4.0: The default is changed to False from True.
^^ ^^^^
Were you tricked by the funny word order? I know I was at first. :)
I looked deeper into the rabbit hole, and it really is a mess for such a
small change. They first added the config to create directories man/1
etc. in 3.3. Then they made it the default in 4.0. Then they realized
making it the default was a mistake, and are going to roll it back in
upcoming v4.0.2. Then they realized the directories should be named
man/man1 (not man/1) etc. and are going to change that in upcoming v4.1.
The patch at hand fixes the issue for v4.0.0 and v4.0.1 (the current
latest release). Are those worth catering for, I don't know. Up to you.
Actually using the feature would be really nice to avoid doing it
manually in the makefile, but then that would require Sphinx v3.3 and
having to take into account the directory name change in v4.1.
*facepalm*
BR,
Jani.
Some references:
https://github.com/sphinx-doc/sphinx/commit/178c05b0597e144fdc2117c7b46ac15723a290e8
https://github.com/sphinx-doc/sphinx/commit/a843fd3db8b588be93b576049a8a291bc4b3ec9d
https://github.com/sphinx-doc/sphinx/issues/7996
https://github.com/sphinx-doc/sphinx/issues/9217
https://github.com/sphinx-doc/sphinx/pull/9232
https://github.com/sphinx-doc/sphinx/pull/9231
next prev parent reply other threads:[~2021-05-19 5:45 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-18 21:40 [PATCH] doc: fix man page build for Sphinx 4.x Jani Nikula
2021-05-18 23:27 ` David Bremner
2021-05-19 5:45 ` Jani Nikula [this message]
2021-05-19 10:45 ` David Bremner
2021-05-19 11:57 ` 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=87h7iznuog.fsf@nikula.org \
--to=jani@nikula.org \
--cc=david@tethera.net \
--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).