From: Eduardo Habkost <ehabkost@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: Fam Zheng <fam@euphon.net>,
Peter Maydell <peter.maydell@linaro.org>,
qemu-devel@nongnu.org, qemu-block@nongnu.org,
Aarushi Mehta <mehta.aaru20@gmail.com>
Subject: Re: [Qemu-devel] [PATCH 1/2] sphinx: add qmp_lexer
Date: Tue, 21 May 2019 17:28:13 -0300 [thread overview]
Message-ID: <20190521202812.GM10764@habkost.net> (raw)
In-Reply-To: <20190521200657.5377-2-jsnow@redhat.com>
On Tue, May 21, 2019 at 04:06:56PM -0400, John Snow 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 notations.
>
> Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>
Thanks for figuring out how to integrate it into Sphinx!
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
--
Eduardo
next prev parent reply other threads:[~2019-05-21 20:44 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-21 20:06 [Qemu-devel] [PATCH 0/2] Add QMP lexer for annotated JSON to Sphinx John Snow
2019-05-21 20:06 ` [Qemu-devel] [PATCH 1/2] sphinx: add qmp_lexer John Snow
2019-05-21 20:28 ` Eduardo Habkost [this message]
2019-05-22 8:49 ` Peter Maydell
2019-05-22 17:51 ` Eduardo Habkost
2019-05-22 19:01 ` John Snow
2019-05-22 21:11 ` Peter Maydell
2019-05-21 20:06 ` [Qemu-devel] [PATCH 2/2] docs/bitmaps: use QMP lexer instead of json John Snow
2019-05-21 20:28 ` Eduardo Habkost
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=20190521202812.GM10764@habkost.net \
--to=ehabkost@redhat.com \
--cc=fam@euphon.net \
--cc=jsnow@redhat.com \
--cc=mehta.aaru20@gmail.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.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.