Thread (11 messages) 11 messages, 7 authors, 2024-02-09

Re: [PATCH v3] Documentation: Document each netlink family

From: Akira Yokosawa <akiyks@gmail.com>
Date: 2024-02-09 23:20:09
Also in: linux-doc, lkml

Hi,

On Fri, 9 Feb 2024 15:47:16 +0100, Vegard Nossum wrote:
On 30/01/2024 17:23, Vegard Nossum wrote:
quoted
We should still fix the writing of .rst to $(srctree), though -- our
use of parse-headers.pl seems to sidestep this by writing the 
intermediate .rst output to Documentation/output/, I'll have to look
a bit more closely.
I have now spent quite a bit of time investigating this.

The main result is that Sphinx really does NOT like it when documents
are located outside of the source root.
There is a hack extension named "kernel_include".
See Documentation/sphinx/kernel_include.py (no, I'm not saying
I understand it.)

The "kernel-include::" directive is exploited only in
Documentation/userspace-api/media/dvb/headers.rst.

I have no idea if Jon is happy to see another subsystem
to start exploiting this extension.

And you should be interested in seeing
Documentation/userspace-api/media/Makefile and how it is integrated
into Documentation/Makefile.

I think media people are doing similar things you'd like to do.

HTH, Akira
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help