Re: [qemu-web PATCH] documentation: update links to readthedocs

[Stefan Hajnoczi]

On Tue, Jan 14, 2020 at 12:11:34PM +0100, Thomas Huth wrote:
> On 13/01/2020 11.35, Alex Bennée wrote:
> > ..and extemporise a little about their state.
> > 
> > Signed-off-by: Alex Bennée <address@hidden>
> > ---
> >  documentation.md | 9 ++++++---
> >  1 file changed, 6 insertions(+), 3 deletions(-)
> > 
> > diff --git a/documentation.md b/documentation.md
> > index f4ef9f4..55d5db6 100644
> > --- a/documentation.md
> > +++ b/documentation.md
> > @@ -3,9 +3,12 @@ title: QEMU documentation
> >  permalink: /documentation/
> >  ---
> >  
> > -The [QEMU user manual](https://qemu.weilnetz.de/qemu-doc.html) can be read 
> > online, courtesy of Stefan Weil.
> > -More documentation is found in the <a 
> > href="https://git.qemu.org/?p=qemu.git;a=tree;f=docs;hb=master";>`docs`</a>
> > -directory of the QEMU git tree.
> > +The [QEMU user manual](https://qemu.weilnetz.de/qemu-doc.html) can be
> > +read online, courtesy of Stefan Weil. There is a partial set of
> > +[developer documentation](https://qemu.readthedocs.io/en/latest/)
> > +which is generated from the QEMU git tree. The process of converting
> > +the rest of the 
> > [`docs`](https://git.qemu.org/?p=qemu.git;a=tree;f=docs;hb=master)
> > +directory is ongoing.
> 
> This has a conflict with Stefan's patch to point to our documentation on
> www.qemu.org now instead:
> 
>  https://patchwork.kernel.org/patch/11234545/
> 
> ... Stefan, looks like the index.html page is still not there yet,
> although your other patch that includes index.html.in in the sources is
> in the repository now? What's the status here?

The qemu.git/master docs are built nightly here (index.html is now
visible!):
https://www.qemu.org/docs/master/

qemu.org's docs are more useful at the moment since they include the
user documentation in addition to the developer documentation.

It's good that we got ownership of the readthedocs.org account for QEMU.
I don't know if rtd will be capable of building QEMU's hodgepodge of
different documentation systems.  It supports Sphinx and Mkdocs but
that's not enough.

Can we redirect readthedocs to qemu.org?

Stefan

signature.asc
Description: PGP signature