[v3] Add QMP lexer for annotated JSON to Sphinx

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

John Snow posted 3 patches 4 years, 10 months ago

Diff against v1 v2
Download series mbox

Test s390x passed

Test checkpatch passed

Test asan passed

Test docker-mingw@fedora passed

Test docker-clang@ubuntu passed

Test FreeBSD passed

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

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

docs/conf.py             |  4 +--
docs/interop/bitmaps.rst | 58 ++++++++++++++++++++--------------------
docs/sphinx/qmp_lexer.py | 43 +++++++++++++++++++++++++++++
3 files changed, 74 insertions(+), 31 deletions(-)
create mode 100644 docs/sphinx/qmp_lexer.py

Expand all Fold all

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

Posted by John Snow 4 years, 10 months ago

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

V3:
 - Also annotate elision indicators '...', which cause
   problems in Sphinx 2.1+
 - Adjust setup.py to cope with future versions of Sphinx
   that change the add_lexer interface

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 (3):
  docs/interop/bitmaps.rst: Fix typos
  sphinx: add qmp_lexer
  docs/bitmaps: use QMP lexer instead of json

 docs/conf.py             |  4 +--
 docs/interop/bitmaps.rst | 58 ++++++++++++++++++++--------------------
 docs/sphinx/qmp_lexer.py | 43 +++++++++++++++++++++++++++++
 3 files changed, 74 insertions(+), 31 deletions(-)
 create mode 100644 docs/sphinx/qmp_lexer.py

-- 
2.20.1