Re: [Qemu-devel] [PATCH v3 2/3] sphinx: add qmp_lexer

[Peter Maydell <peter.maydell@linaro.org>]

On Mon, 3 Jun 2019 at 22:47, John Snow <jsnow@redhat.com> wrote:
>
> Sphinx, through Pygments, does not like annotated json examples very
> much. In some versions of Sphinx (1.7), it will render the non-json
> portions of code blocks in red, but in newer versions (2.0) it will
> throw an exception and not highlight the block at all. Though we can
> suppress this warning, it doesn't bring back highlighting on non-strict
> json blocks.
>
> We can alleviate this by creating a custom lexer for QMP examples that
> allows us to properly highlight these examples in a robust way, keeping
> our directionality and elision notations.
>
> Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
(mostly reviewing the sphinx config bits -- I trust that
the actual lexer does what it says on the tin :-))

thanks
-- PMM