Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-10-02 Thread John Snow
On 10/2/20 5:19 AM, Markus Armbruster wrote: John Snow writes: On 10/1/20 4:52 AM, Markus Armbruster wrote: John Snow writes: On 9/30/20 4:47 AM, Markus Armbruster wrote: John Snow writes: I did not say "sphinx beautiful", just "sphinx compatible". They will not throw errors when parse

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-10-02 Thread Markus Armbruster
John Snow writes: > On 10/1/20 4:52 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> On 9/30/20 4:47 AM, Markus Armbruster wrote: John Snow writes: > I did not say "sphinx beautiful", just "sphinx compatible". They will > not throw errors when parsed and interpreted a

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-10-01 Thread John Snow
On 10/1/20 4:52 AM, Markus Armbruster wrote: John Snow writes: On 9/30/20 4:47 AM, Markus Armbruster wrote: John Snow writes: I did not say "sphinx beautiful", just "sphinx compatible". They will not throw errors when parsed and interpreted as ReST. "Bang on the keyboard until Sphinx does

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-10-01 Thread John Snow
On 10/1/20 4:54 AM, Markus Armbruster wrote: John Snow writes: On 9/30/20 4:47 AM, Markus Armbruster wrote: Sadly, the fact that start_if() and end_if() are functions isn't immediately obvious anymore. I've seen :func:`start_if` elsewhere. Is this something we should or want to use? Looks

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-10-01 Thread Markus Armbruster
John Snow writes: > On 9/30/20 4:47 AM, Markus Armbruster wrote: >> John Snow writes: >> >>> I did not say "sphinx beautiful", just "sphinx compatible". They will >>> not throw errors when parsed and interpreted as ReST. >> "Bang on the keyboard until Sphinx doesn't throw errors anymore" >> mig

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-10-01 Thread Markus Armbruster
John Snow writes: > On 9/30/20 4:47 AM, Markus Armbruster wrote: >> Sadly, the fact that start_if() and end_if() are functions isn't >> immediately obvious anymore. >> I've seen :func:`start_if` elsewhere. Is this something we should >> or >> want to use? > > Looks like `start_if()` works just f

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-09-30 Thread John Snow
On 9/30/20 4:47 AM, Markus Armbruster wrote: Sadly, the fact that start_if() and end_if() are functions isn't immediately obvious anymore. I've seen :func:`start_if` elsewhere. Is this something we should or want to use? Looks like `start_if()` works just fine too. If you are hard-set in wan

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-09-30 Thread John Snow
On 9/30/20 4:47 AM, Markus Armbruster wrote: John Snow writes: I did not say "sphinx beautiful", just "sphinx compatible". They will not throw errors when parsed and interpreted as ReST. "Bang on the keyboard until Sphinx doesn't throw errors anymore" might be good enough for a certain kind

Re: [PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-09-30 Thread Markus Armbruster
John Snow writes: > I did not say "sphinx beautiful", just "sphinx compatible". They will > not throw errors when parsed and interpreted as ReST. "Bang on the keyboard until Sphinx doesn't throw errors anymore" might be good enough for a certain kind of mathematician, but a constructive solution

[PATCH v4 04/46] qapi: modify docstrings to be sphinx-compatible

2020-09-29 Thread John Snow
I did not say "sphinx beautiful", just "sphinx compatible". They will not throw errors when parsed and interpreted as ReST. Signed-off-by: John Snow --- scripts/qapi/gen.py| 6 -- scripts/qapi/parser.py | 9 + 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/scripts