[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v3 31/33] docs: Stop building qemu-doc

From: Peter Maydell
Subject: Re: [PATCH v3 31/33] docs: Stop building qemu-doc
Date: Thu, 12 Mar 2020 10:11:34 +0000

On Thu, 12 Mar 2020 at 06:06, Markus Armbruster <address@hidden> wrote:
> Would it be possible to additionally render a complete manual as one
> humongous .html?  Without an index, there's only search, and the
> ergonomics of searching within a single page are so much better.

There is a "build one big fat HTML page" Sphinx builder,
I think. But again, I'm dubious about increasing the number
of supported output formats -- it's all extra makefile complexity
and more things to get right in 'make install' and so on.

PS: assuming you have js enabled, each HTML manual has a js
search engine built in, eg the 'quick search' box at the bottom
of the LHS navigation bar on

> I'm tempted to write a trivial QAPI doc comment backend to spit out
> minimally processed doc comments as one plain text file just for that.

What would be the difference there compared to just looking
at the manpage? The manpages don't have the full content
of all the HTML manuals, but the QAPI reference manpages
will have all the QAPI content.

-- PMM

reply via email to

[Prev in Thread] Current Thread [Next in Thread]