On 10/7/19 9:54 AM, Randy Dunlap wrote:
> On 10/7/19 8:41 AM, Jonathan Corbet wrote:
>> On Wed, 2 Oct 2019 16:16:07 -0700
>> Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:
>>
>>> It seems that _SPHINXDIRS is empty. I'm getting (short extract):
>>>
>>> make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2
>>> valid values for SPHINXDIRS are:
>>>
>>> make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build
>>> configuration. This is e.g. useful to build with nit-picking config.
>>>
>>> Default location for the generated documents is Documentation/output
>>
>> Hmm...it looks like that broke with 9fc3a18a942f, which got rid of the
>> various conf.py files. Something like the following seems to do the right
>> thing? (It also shows that we have way too many top-level directories, but
>> that's a separate issue...)
>
> true dat.
>
>> Thanks,
>>
>> jon
>>
>> From d402c2de65bb9353e6222a05095f32929ae62373 Mon Sep 17 00:00:00 2001
>> From: Jonathan Corbet <corbet@xxxxxxx>
>> Date: Mon, 7 Oct 2019 09:38:58 -0600
>> Subject: [PATCH] docs: Fix "make help" suggestion for SPHINXDIR
>>
>> Commit 9fc3a18a942f ("docs: remove extra conf.py files") broke the setting
>> of _SPHINXDIRS in Documentation/Makefile. Let's just have it look for an
>> index.rst file instead.
>>
>> Fixes: 9fc3a18a942f ("docs: remove extra conf.py files")
>> Reported-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>> Signed-off-by: Jonathan Corbet <corbet@xxxxxxx>
>
> Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Thanks.
I request that this patch be merged into mainline
sooner rather than later.
Thanks.
>> ---
>> Documentation/Makefile | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/Makefile b/Documentation/Makefile
>> index c6e564656a5b..ce8eb63b523a 100644
>> --- a/Documentation/Makefile
>> +++ b/Documentation/Makefile
>> @@ -13,7 +13,7 @@ endif
>> SPHINXBUILD = sphinx-build
>> SPHINXOPTS =
>> SPHINXDIRS = .
>> -_SPHINXDIRS = $(patsubst $(srctree)/Documentation/%/conf.py,%,$(wildcard $(srctree)/Documentation/*/conf.py))
>> +_SPHINXDIRS = $(patsubst $(srctree)/Documentation/%/index.rst,%,$(wildcard $(srctree)/Documentation/*/index.rst))
>> SPHINX_CONF = conf.py
>> PAPER =
>> BUILDDIR = $(obj)/output
>>
>
>
--
~Randy
Reported-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
