Re: [Qemu-devel] [PATCH] docs: apply some qemu.org-like CSS style to HTML

["Daniel P. Berrangé" <berrange@redhat.com>]

On Wed, Nov 28, 2018 at 07:40:09PM +0400, Marc-André Lureau wrote:
> Hi
> 
> On Wed, Nov 28, 2018 at 7:27 PM Stefan Weil <sw@weilnetz.de> wrote:
> >
> > Am 22.11.2018 um 15:17 schrieb Marc-André Lureau:
> > > Style a bit the HTML documents, to make them look like qemu.org pages.
> > >
> > > Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> > > ---
> > >  Makefile                     |   2 +
> > >  docs/texinfo-extra-head.html |   7 ++
> > >  docs/texinfo.css             | 226 +++++++++++++++++++++++++++++++++++
> > >  3 files changed, 235 insertions(+)
> > >  create mode 100644 docs/texinfo-extra-head.html
> > >  create mode 100644 docs/texinfo.css
> >
> >
> > I tried this patch, and here are the results without the patch and with
> > the patch, so everybody can compare both looks:
> >
> > old: https://qemu.weilnetz.de/doc/qemu-doc.html
> > new: https://qemu.weilnetz.de/doc/3.1/qemu-doc.html
> >
> > I like the new look and can use it from now on, no matter whether it is
> > merged into QEMU 3.1 or delayed for release 4.
> 
> With my limited knowledge of CSS, I tried to apply a style close to
> what qemu.org already uses. Further tweaks would be welcome, but
> better left to someone with more web design skills.
> 
> >
> > Tested-by: Stefan Weil <sw@weilnetz.de>
> >
> > PS: https://qemu.weilnetz.de/doc/3.1/qemu-ga-ref.html and
> > https://qemu.weilnetz.de/doc/3.1/qemu-qmp-ref.html are also candidates
> > for the new look.
> 
> Oh, but the style is also applied for them, as they are also generated
> from the same texinfo->html process.
> 
> I wonder if the generated pages could be somehow uploaded on release
> on qemu.org, or simply committed to qemu-web?

Committing them to qemu-web would be a fairly straightforward approach,
not requiring any extra tooling work. In particular it would make it pretty
easy to provide docs for historical versions of QEMU too.

The alternative is to write a jekyll plugin which fetches the qemu
releases & generates docs dynamically, but this would much more
complex & fragile IMHO.

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 :|