Re: [Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools for python/qemu

2019-07-29 Thread John Snow
On 7/26/19 5:16 PM, Eduardo Habkost wrote: > CCing Cleber and Gabriel. Comments at the "conclusions" section > below: > > On Wed, Jul 24, 2019 at 05:06:41PM -0400, John Snow wrote: >> Has anyone on this list experimented with these tools? >> >> I was hoping to use them to document things like

Re: [Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools for python/qemu

2019-07-26 Thread Eduardo Habkost
CCing Cleber and Gabriel. Comments at the "conclusions" section below: On Wed, Jul 24, 2019 at 05:06:41PM -0400, John Snow wrote: > Has anyone on this list experimented with these tools? > > I was hoping to use them to document things like the python/machine.py > and python/qmp.py modules to hel

Re: [Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools for python/qemu

2019-07-25 Thread John Snow
On 7/25/19 5:02 AM, Peter Maydell wrote: > On Wed, 24 Jul 2019 at 22:06, John Snow wrote: >> And then you can edit e.g. the top-level index.rst TOC in docs/index.rst >> to look like this: >> >> ``` >> .. toctree:: >>:maxdepth: 2 >>:caption: Contents: >> >>interop/index >>devel/i

Re: [Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools for python/qemu

2019-07-25 Thread Peter Maydell
On Wed, 24 Jul 2019 at 22:06, John Snow wrote: > And then you can edit e.g. the top-level index.rst TOC in docs/index.rst > to look like this: > > ``` > .. toctree:: >:maxdepth: 2 >:caption: Contents: > >interop/index >devel/index >specs/index >modules > ``` This is obviou

[Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools for python/qemu

2019-07-24 Thread John Snow
Has anyone on this list experimented with these tools? I was hoping to use them to document things like the python/machine.py and python/qmp.py modules to help demonstrate some of our internal tooling API (for test writers, GSoC/Outreachy interns, folks who want to script QEMU at a level between w