From: "Daniel P. Berrangé" <berrange@redhat.com>
To: "Alex Bennée" <alex.bennee@linaro.org>
Cc: pbonzini@redhat.com, Thomas Huth <thuth@redhat.com>,
qemu-devel@nongnu.org, Stefan Hajnoczi <stefanha@redhat.com>
Subject: Re: [qemu-web PATCH] documentation: update links to readthedocs
Date: Wed, 15 Jan 2020 12:01:34 +0000 [thread overview]
Message-ID: <20200115120134.GH93923@redhat.com> (raw)
In-Reply-To: <87zhepkk6j.fsf@linaro.org>
On Wed, Jan 15, 2020 at 11:56:04AM +0000, Alex Bennée wrote:
>
> Stefan Hajnoczi <stefanha@redhat.com> writes:
>
> > 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.
>
> And I think we want to continue hosting them on qemu.org. Is it possible
> to theme them under the website branding? Stefan's version includes a
> banner and background icon so it would be nice to at least fit in with
> the reset of the site.
I did a demo of this a while back:
https://www.mail-archive.com/qemu-devel@nongnu.org/msg578110.html
Essentially you just need to strip the HTML header down to the
<body> content. Then add the jekyll header and run its site
generator which will add the new HTML header with theme.
In my patches above I committed the ref docs .html files to qemu-web.git
but this is not required. They just need to be placed in any directory
on the server where jekyll build process runs, so that we can access
them when building the static site content.
Regards,
Daniel
--
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org -o- https://fstop138.berrange.com :|
|: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
next prev parent reply other threads:[~2020-01-15 12:02 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
2020-01-15 11:56 ` Alex Bennée
2020-01-15 12:01 ` Daniel P. Berrangé [this message]
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=20200115120134.GH93923@redhat.com \
--to=berrange@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
--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).