[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools f
From: |
Peter Maydell |
Subject: |
Re: [Qemu-devel] Exploring Sphinx, autodoc, apidoc, and coverage tools for python/qemu |
Date: |
Thu, 25 Jul 2019 10:02:26 +0100 |
On Wed, 24 Jul 2019 at 22:06, John Snow <address@hidden> 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 obviously just prototyping, but you don't want to put
anything new in this top level index.rst -- it's only used
for by-hand full-tree docs builds. Builds from the makefile
rules will just build our separate manuals (interop, devel,
specs) separately. You want to put your new documentation into
whichever manual is best suited (probably devel/, but possibly
interop/ in some cases?)
(Will read the rest of this email later.)
thanks
-- PMM