Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings""

From	Jonathan Corbet <corbet@lwn.net>
Newsgroups	linux.kernel
Subject	Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings""
Date	2016-08-09 16:10 +0200
Message-ID	<s4fTc-bN-31@gated-at.bofh.it> (permalink)
References	<s3VB7-3GF-7@gated-at.bofh.it> <s40r7-6NC-5@gated-at.bofh.it> <s4fJw-8kJ-39@gated-at.bofh.it>
Organization	LWN.net

Show all headers | View raw

On Tue, 9 Aug 2016 15:56:15 +0200
Daniel Vetter <daniel.vetter@ffwll.ch> wrote:

> > So I honestly think we should just set the highlight language to "none" by
> > default.  The syntax highlighting in code samples adds some colorful sugar
> > to the docs, but it's not really all that useful, IMO, and people who want
> > it can override the language in the right places.
> >
> > Any strong opposition to this idea?  
> 
> Hm right, didn't realize that this is where it's coming from. No
> strong opinion from my side on highlighting the C block quotes really.
> Otoh that highlighting is rather pretty. Could we perhaps just shut
> sphinx up about the "C" highlighting issues?

We can look into that, but, in the end, we'll always have a lot of literal
blocks that are not C code.  Even if Sphinx doesn't warn about them, it
tries to mark them up as C with occasionally strange results.  I'm not
really convinced it's a net win.

jon

Thread

[PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings"" Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-08-08 18:30 +0200
  Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings"" Jonathan Corbet <corbet@lwn.net> - 2016-08-08 23:40 +0200
    Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings"" Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-08-09 16:00 +0200
      Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings"" Jonathan Corbet <corbet@lwn.net> - 2016-08-09 16:10 +0200
        Re: [PATCH] Revert "Revert "doc/sphinx: Enable keep_warnings"" Markus Heiser <markus.heiser@darmarit.de> - 2016-08-09 16:20 +0200

csiph-web