Skip to content

Add QMP lexer for annotated JSON to Sphinx

John Snow qemu-devel 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest3 patches 2 repliesIn review
  2. v22 patches 1 replySuperseded
  3. v12 patches 6 repliesSuperseded

Changes in v3 from the cover letter

- 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

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3docs/interop/bitmaps.rst: Fix typosdocs/interop/bitmaps.rst+2 -21 reply
2/3sphinx: add qmp_lexerdocs/conf.py docs/sphinx/qmp_lexer.py+45 -21 reply
3/3docs/bitmaps: use QMP lexer instead of jsondocs/interop/bitmaps.rst+27 -270 replies

Reviews trailers per patch

All 3 patches have a Reviewed-by or Acked-by.

PatchEduardo HabkostVladimir Sementsov-OgievskiyPeter Maydell
1/3R-b
2/3R-b
3/3R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v3 thread

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

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

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
Signature · 1 line
2.20.1