qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Stefan Hajnoczi <stefanha@redhat.com>
To: Thomas Huth <thuth@redhat.com>
Cc: pbonzini@redhat.com, "Alex Bennée" <alex.bennee@linaro.org>,
	qemu-devel@nongnu.org
Subject: Re: [qemu-web PATCH] documentation: update links to readthedocs
Date: Wed, 15 Jan 2020 11:10:42 +0000	[thread overview]
Message-ID: <20200115111042.GA163546@stefanha-x1.localdomain> (raw)
In-Reply-To: <2331e0b7-cad9-7b53-3d30-7fb88d692c8a@redhat.com>

[-- Attachment #1: Type: text/plain, Size: 2152 bytes --]

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 <alex.bennee@linaro.org>
> > ---
> >  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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

  reply	other threads:[~2020-01-15 11:11 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-13 10:35 [qemu-web PATCH] documentation: update links to readthedocs Alex Bennée
2020-01-14 11:04 ` Stefan Hajnoczi
2020-01-14 11:11 ` Thomas Huth
2020-01-15 11:10   ` Stefan Hajnoczi [this message]
2020-01-15 11:56     ` Alex Bennée
2020-01-15 12:01       ` Daniel P. Berrangé
2020-01-20 10:16         ` Stefan Hajnoczi
2020-01-20 10:31     ` Peter Maydell
2020-02-03 11:46     ` Peter Maydell
2020-02-03 11:54       ` Thomas Huth
2020-02-03 12:07         ` Peter Maydell
2020-02-03 12:12           ` Thomas Huth
2020-02-03 12:38             ` Peter Maydell
2020-02-03 12:44               ` Peter Maydell
2020-02-03 12:46                 ` Thomas Huth
2020-02-03 13:21                 ` Thomas Huth
2020-02-05 10:28       ` Stefan Hajnoczi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200115111042.GA163546@stefanha-x1.localdomain \
    --to=stefanha@redhat.com \
    --cc=alex.bennee@linaro.org \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=thuth@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).