docs: switch to use rst2html5 instead of rst2html

[libvirt] [PATCH] docs: switch to use rst2html5 instead of rst2html

Posted by Daniel P. Berrangé 4 years, 4 months ago

Now that we don't have to support CentOS 7's python2-docutils, we can
use the rst2html5 tool instead, which generates HTML5 output instead
of HTML4 output. This matches what we used for the original HTML docs
since

  commit b1c81567c7172bc9dcd701cf46ea3f87725d62c7
  Author: Daniel P. Berrangé <berrange@redhat.com>
  Date:   Wed Jul 26 18:01:25 2017 +0100

    docs: switch to using HTML5 doctype declaration

Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
 m4/virt-external-programs.m4 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/m4/virt-external-programs.m4 b/m4/virt-external-programs.m4
index ed634a4c73..a23c69d54b 100644
--- a/m4/virt-external-programs.m4
+++ b/m4/virt-external-programs.m4
@@ -33,7 +33,7 @@ AC_DEFUN([LIBVIRT_CHECK_EXTERNAL_PROGRAMS], [
   then
     AC_MSG_ERROR("xsltproc is required to build libvirt")
   fi
-  AC_PATH_PROGS([RST2HTML], [rst2html rst2html.py rst2html-3], [])
+  AC_PATH_PROGS([RST2HTML], [rst2html5 rst2html5.py rst2html5-3], [])
   if test -z "$RST2HTML"
   then
     AC_MSG_ERROR("rst2html is required to build libvirt")
-- 
2.23.0

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] docs: switch to use rst2html5 instead of rst2html

Posted by Andrea Bolognani 4 years, 4 months ago

On Fri, 2019-12-06 at 17:50 +0000, Daniel P. Berrangé wrote:
> Now that we don't have to support CentOS 7's python2-docutils, we can
> use the rst2html5 tool instead, which generates HTML5 output instead
> of HTML4 output.

Ubuntu 16.04 still has rst2html only, see

  https://packages.ubuntu.com/xenial/all/python3-docutils/filelist

Can we just add the rst2html5 variants to the front of the list, so
that they will be picked up wherever available without breaking
Ubuntu 16.04?

-- 
Andrea Bolognani / Red Hat / Virtualization

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] docs: switch to use rst2html5 instead of rst2html

Posted by Daniel P. Berrangé 4 years, 4 months ago

On Wed, Dec 11, 2019 at 10:16:28AM +0100, Andrea Bolognani wrote:
> On Fri, 2019-12-06 at 17:50 +0000, Daniel P. Berrangé wrote:
> > Now that we don't have to support CentOS 7's python2-docutils, we can
> > use the rst2html5 tool instead, which generates HTML5 output instead
> > of HTML4 output.
> 
> Ubuntu 16.04 still has rst2html only, see
> 
>   https://packages.ubuntu.com/xenial/all/python3-docutils/filelist
> 
> Can we just add the rst2html5 variants to the front of the list, so
> that they will be picked up wherever available without breaking
> Ubuntu 16.04?

Yeah can do.

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

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list