Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-24 Thread Markus Armbruster
Peter Maydell writes: > On Mon, 21 Sep 2020 at 19:06, Peter Maydell wrote: >> (I've just noticed that with Sphinx 1.6, which we still have >> to support, the file/line info isn't passed through, so you get: >> >> Warning, treated as error: >> /home/petmay01/linaro/qemu-from-laptop/qemu/docs/inte

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-24 Thread Peter Maydell
On Mon, 21 Sep 2020 at 19:06, Peter Maydell wrote: > (I've just noticed that with Sphinx 1.6, which we still have > to support, the file/line info isn't passed through, so you get: > > Warning, treated as error: > /home/petmay01/linaro/qemu-from-laptop/qemu/docs/interop/qemu-qmp-ref.rst:7:Bullet >

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-24 Thread Peter Maydell
On Tue, 22 Sep 2020 at 12:42, Markus Armbruster wrote: > > Peter Maydell writes: > > > On Fri, 4 Sep 2020 at 13:29, Markus Armbruster wrote: > >> Got a pointer to "Writing Sphinx Extensions for Dummies" or similar? > > > > The upstream documentation on extending Sphinx is probably > > a good pla

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-22 Thread Markus Armbruster
Peter Maydell writes: > On Fri, 4 Sep 2020 at 15:44, Markus Armbruster wrote: >> >> $ pycodestyle docs/sphinx/qapidoc.py >> docs/sphinx/qapidoc.py:42:1: E302 expected 2 blank lines, found 1 >> docs/sphinx/qapidoc.py:50:1: E302 expected 2 blank lines, found 1 >> docs/sphinx/qapidoc.py:74:80: E501

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-22 Thread Markus Armbruster
Peter Maydell writes: > On Fri, 4 Sep 2020 at 13:29, Markus Armbruster wrote: >> >> Peter Maydell writes: >> >> > Some of our documentation is auto-generated from documentation >> > comments in the JSON schema. >> > >> > For Sphinx, rather than creating a file to include, the most natural >> >

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-21 Thread Peter Maydell
On Fri, 4 Sep 2020 at 13:29, Markus Armbruster wrote: > > Peter Maydell writes: > > > Some of our documentation is auto-generated from documentation > > comments in the JSON schema. > > > > For Sphinx, rather than creating a file to include, the most natural > > way to handle this is to have a sm

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-21 Thread Peter Maydell
On Fri, 4 Sep 2020 at 15:44, Markus Armbruster wrote: > > $ pycodestyle docs/sphinx/qapidoc.py > docs/sphinx/qapidoc.py:42:1: E302 expected 2 blank lines, found 1 > docs/sphinx/qapidoc.py:50:1: E302 expected 2 blank lines, found 1 > docs/sphinx/qapidoc.py:74:80: E501 line too long (80 > 79 charact

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-04 Thread Peter Maydell
On Fri, 4 Sep 2020 at 15:44, Markus Armbruster wrote: > > $ pycodestyle docs/sphinx/qapidoc.py > docs/sphinx/qapidoc.py:42:1: E302 expected 2 blank lines, found 1 > docs/sphinx/qapidoc.py:50:1: E302 expected 2 blank lines, found 1 > docs/sphinx/qapidoc.py:74:80: E501 line too long (80 > 79 charact

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-04 Thread Markus Armbruster
$ pycodestyle docs/sphinx/qapidoc.py docs/sphinx/qapidoc.py:42:1: E302 expected 2 blank lines, found 1 docs/sphinx/qapidoc.py:50:1: E302 expected 2 blank lines, found 1 docs/sphinx/qapidoc.py:74:80: E501 line too long (80 > 79 characters) docs/sphinx/qapidoc.py:388:80: E501 line too long (80 > 79

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-09-04 Thread Markus Armbruster
Peter Maydell writes: > Some of our documentation is auto-generated from documentation > comments in the JSON schema. > > For Sphinx, rather than creating a file to include, the most natural > way to handle this is to have a small custom Sphinx extension which > processes the JSON file and insert

Re: [PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-08-14 Thread Richard Henderson
On 8/10/20 12:50 PM, Peter Maydell wrote: > Some of our documentation is auto-generated from documentation > comments in the JSON schema. > > For Sphinx, rather than creating a file to include, the most natural > way to handle this is to have a small custom Sphinx extension which > processes the J

[PATCH v5 09/20] docs/sphinx: Add new qapi-doc Sphinx extension

2020-08-10 Thread Peter Maydell
Some of our documentation is auto-generated from documentation comments in the JSON schema. For Sphinx, rather than creating a file to include, the most natural way to handle this is to have a small custom Sphinx extension which processes the JSON file and inserts documentation into the rST file b