Re: [PATCH RFC] Make the docs build "work" with Sphinx 3.x

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Mon, 21 Sep 2020, Matthew Wilcox <willy@xxxxxxxxxxxxx> wrote:
> On Fri, Sep 04, 2020 at 10:29:25AM -0600, Jonathan Corbet wrote:
>> +# cdomain is badly broken in Sphinx 3+.  Leaving it out generates *most*
>> +# of the docs correctly, but not all.  Scream bloody murder but allow
>> +# the process to proceed; hopefully somebody will fix this properly soon.
>> +#
>> +if major >= 3:
>> +    sys.stderr.write('''WARNING: The kernel documentation build process
>> +	does not work correctly with Sphinx v3.0 and above.  Expect errors
>> +	in the generated output.
>
> Should we be converting the kernel-doc script to output 3.0-style markup
> for structs?

IIUC it's not backwards compatible with Sphinx pre-3.0, so you'd either
have to require Sphinx 3.0 or have kernel-doc emit both, depending on
the Sphinx version.


BR,
Jani.


>
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#c-roles

-- 
Jani Nikula, Intel Open Source Graphics Center



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux