Hiya, this is a series that explores a potential syntax for a
designated "Intro" section. Markus knows why I want this, but for
everyone else: a designated "Introduction" section is useful for the
desired "inliner" feature for the new QAPI doc system. Commits explain
a bit more. This is prep work and doesn't really change anything
tangibly except source code syntax for the QAPI docs.
It is designed so that this conversion can happen incrementally with
no actual difference to the rendered manuals, so each QAPI module can
be converted one at a time for easier review and merging in an
arbitrary order.
V4: A few minor comment touch-ups; omitted module conversions.
V3: changed intro section syntax, made various fixes and changes; I'm
going to be honest Markus I did not keep a strict account this time
;_;
V2: punt intro sections to the subsequent line and adjust the parser
accordingly. Left as an RFC patch that undoes some things this series
does instead of properly factoring into the series.
John Snow (13):
python: temporarily restrict max mypy version
tests/qapi: generate output in source order
qapi/docs: remove unused QAPIDoc subsection members
qapi/docs: add has_features property
qapi/docs: make remaining subsection members "private"
qapi/docs: fix comment phrasing
qapi/docs: add "Intro" section
qapi/parser: move _insert_near_kind() method
qapi/parser: add mea culpa comment for ensure_returns
qapi/docs: adjust stub member insertion algorithm
qapi/docs: remove implicit Plain section
qapi/docs: add rendering for INTRO sections
qapi/docs: add "Intro" section parsing
docs/devel/qapi-code-gen.rst | 16 ++--
docs/sphinx/qapidoc.py | 61 +++++++-----
python/setup.cfg | 3 +-
scripts/qapi/parser.py | 167 +++++++++++++++++++--------------
tests/qapi-schema/doc-good.out | 86 +++++++++--------
tests/qapi-schema/test-qapi.py | 14 +--
6 files changed, 197 insertions(+), 150 deletions(-)
--
2.54.0