Re: [PATCH] doc: fix man page build for Sphinx 4.x
Jani Nikula writes: > Sphinx 4.0 changed the default value of man_make_section_directory > from False to True. We create the section directories and move the > files manually, so fix the immediate man build failure by disabling > the feature. > > The Sphinx documentation on this [1] is confusing, and has the change > backwards. Git history says the default changed from False to True. Applied to release and master. d ___ notmuch mailing list -- notmuch@notmuchmail.org To unsubscribe send an email to notmuch-le...@notmuchmail.org
Re: [PATCH] doc: fix man page build for Sphinx 4.x
Jani Nikula writes: > On Tue, 18 May 2021, David Bremner wrote: >> Jani Nikula 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. :) Oops, busted. d ___ notmuch mailing list -- notmuch@notmuchmail.org To unsubscribe send an email to notmuch-le...@notmuchmail.org
Re: [PATCH] doc: fix man page build for Sphinx 4.x
On Tue, 18 May 2021, David Bremner wrote: > Jani Nikula 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 ___ notmuch mailing list -- notmuch@notmuchmail.org To unsubscribe send an email to notmuch-le...@notmuchmail.org
Re: [PATCH] doc: fix man page build for Sphinx 4.x
Jani Nikula 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. ___ notmuch mailing list -- notmuch@notmuchmail.org To unsubscribe send an email to notmuch-le...@notmuchmail.org
