From: Jani Nikula <jani.nikula@linux.intel.com>
To: Matthew Wilcox <willy@infradead.org>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Markus Heiser <markus.heiser@darmarit.de>
Subject: Re: [PATCH RFC] Make the docs build "work" with Sphinx 3.x
Date: Tue, 22 Sep 2020 10:23:46 +0300 [thread overview]
Message-ID: <87sgbaqnp9.fsf@intel.com> (raw)
In-Reply-To: <20200921222639.GY32101@casper.infradead.org>
On Mon, 21 Sep 2020, Matthew Wilcox <willy@infradead.org> 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
next prev parent reply other threads:[~2020-09-22 7:23 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-04 16:29 [PATCH RFC] Make the docs build "work" with Sphinx 3.x Jonathan Corbet
2020-09-21 22:26 ` Matthew Wilcox
2020-09-22 7:19 ` Mauro Carvalho Chehab
2020-09-22 7:23 ` Jani Nikula [this message]
2020-09-22 16:56 ` Jonathan Corbet
2020-09-23 9:01 ` Mauro Carvalho Chehab
2020-09-23 11:53 ` Mauro Carvalho Chehab
2020-09-23 14:02 ` Mauro Carvalho Chehab
2020-09-24 7:02 ` Mauro Carvalho Chehab
2020-09-24 11:22 ` [PATCH 0/2] Start supporting builds with Sphinx 3.1+ Mauro Carvalho Chehab
2020-09-24 11:22 ` [PATCH 1/2] docs: cdomain.py: add support for two new Sphinx 3.1+ tags Mauro Carvalho Chehab
2020-09-24 15:43 ` Jonathan Corbet
2020-09-24 16:13 ` Mauro Carvalho Chehab
2020-09-24 16:22 ` Jonathan Corbet
2020-09-25 4:14 ` Mauro Carvalho Chehab
2020-09-24 11:22 ` [PATCH 2/2] media: docs: make CEC documents compatible with Sphinx 3.1+ Mauro Carvalho Chehab
2020-09-24 12:47 ` [PATCH RFC] Make the docs build "work" with Sphinx 3.x Mauro Carvalho Chehab
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87sgbaqnp9.fsf@intel.com \
--to=jani.nikula@linux.intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
--cc=willy@infradead.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.