[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [qemu-web PATCH] documentation: update links to readthedocs
|
From: |
Daniel P . Berrangé |
|
Subject: |
Re: [qemu-web PATCH] documentation: update links to readthedocs |
|
Date: |
Wed, 15 Jan 2020 12:01:34 +0000 |
|
User-agent: |
Mutt/1.12.1 (2019-06-15) |
On Wed, Jan 15, 2020 at 11:56:04AM +0000, Alex Bennée wrote:
>
> Stefan Hajnoczi <address@hidden> 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 <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.
>
> 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/address@hidden/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 :|