[v2] Add QMP lexer for annotated JSON to Sphinx

[Qemu-devel] [PATCH v2 0/2] Add QMP lexer for annotated JSON to Sphinx

John Snow posted 2 patches 4 years, 11 months ago

Diff against v1 v3
Download series mbox

Test FreeBSD passed

Test docker-clang@ubuntu passed

Test s390x passed

Test docker-mingw@fedora passed

Test checkpatch passed

Test asan passed

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20190523121230.17193-1-jsnow@redhat.com

Maintainers: Peter Maydell <peter.maydell@linaro.org>, John Snow <jsnow@redhat.com>, Fam Zheng <fam@euphon.net>

There is a newer version of this series

docs/conf.py             |  4 +--
docs/interop/bitmaps.rst | 54 ++++++++++++++++++++--------------------
docs/sphinx/qmp_lexer.py | 34 +++++++++++++++++++++++++
3 files changed, 63 insertions(+), 29 deletions(-)
create mode 100644 docs/sphinx/qmp_lexer.py

Expand all Fold all

[Qemu-devel] [PATCH v2 0/2] Add QMP lexer for annotated JSON to Sphinx

Posted by John Snow 4 years, 11 months ago

QMP isn't json. It turns out Pygments cares about this.
Teach Pygments to go with the annotated flow.

V2:
 - Change GPL2 to GPLv2+ (Peter Maydell)
 - Change "highlights" to "lexes" in docstrings
 - Fix typo ("Sphinx()" => "Sphinx") in docstring

Reported-by: Aarushi Mehta <mehta.aaru20@gmail.com>

John Snow (2):
  sphinx: add qmp_lexer
  docs/bitmaps: use QMP lexer instead of json

 docs/conf.py             |  4 +--
 docs/interop/bitmaps.rst | 54 ++++++++++++++++++++--------------------
 docs/sphinx/qmp_lexer.py | 34 +++++++++++++++++++++++++
 3 files changed, 63 insertions(+), 29 deletions(-)
 create mode 100644 docs/sphinx/qmp_lexer.py

-- 
2.20.1

Re: [Qemu-devel] [PATCH v2 0/2] Add QMP lexer for annotated JSON to Sphinx

Posted by John Snow 4 years, 10 months ago

Peter: I think this one would be through your tree if anyone's, yes? Any
thoughts?

--js

On 5/23/19 8:12 AM, John Snow wrote:
> QMP isn't json. It turns out Pygments cares about this.
> Teach Pygments to go with the annotated flow.
> 
> V2:
>  - Change GPL2 to GPLv2+ (Peter Maydell)
>  - Change "highlights" to "lexes" in docstrings
>  - Fix typo ("Sphinx()" => "Sphinx") in docstring
> 
> Reported-by: Aarushi Mehta <mehta.aaru20@gmail.com>
> 
> John Snow (2):
>   sphinx: add qmp_lexer
>   docs/bitmaps: use QMP lexer instead of json
> 
>  docs/conf.py             |  4 +--
>  docs/interop/bitmaps.rst | 54 ++++++++++++++++++++--------------------
>  docs/sphinx/qmp_lexer.py | 34 +++++++++++++++++++++++++
>  3 files changed, 63 insertions(+), 29 deletions(-)
>  create mode 100644 docs/sphinx/qmp_lexer.py
>