[libvirt PATCH] docs: add 'edit this page' link to footer of every page

Andrea Bolognani abologna at redhat.com
Wed Apr 8 17:05:17 UTC 2020


On Wed, 2020-04-08 at 16:21 +0100, Daniel P. Berrangé wrote:
> +++ b/docs/Makefile.am
> @@ -429,6 +429,10 @@ manpages/%.html.in: manpages/%.rst
>  %.html.tmp: %.html.in site.xsl subsite.xsl page.xsl \
>  		$(acl_generated)
>  	$(AM_V_GEN)name=`echo $@ | sed -e 's/.tmp//'`; \
> +          genhtmlin=`echo $@ | sed -e 's/.tmp/.in/'`; \
> +          rst=`echo $@ | sed -e 's/.html.tmp/.rst/'`; \
> +          src="$$genhtmlin"; \
> +          test -f "$$genhtmlin" && src="$$rst"; \

The indentation is all wrong here.

> @@ -438,6 +442,7 @@ manpages/%.html.in: manpages/%.rst
>  	    style=subsite.xsl; \
>  	  fi; \
>  	  $(XSLTPROC) --stringparam pagename $$name \
> +            --stringparam pagesrc $$src \

Here too.

> +++ b/docs/page.xsl
> @@ -150,6 +151,12 @@
>            </div>
>          </div>
>          <div id="footer">
> +          <div id="contact">

The id is wrong, you need a new one for this footer section.

> +            <h3>Contribute</h3>
> +            <ul>
> +              <li><a href="https://gitlab.com/libvirt/libvirt/-/blob/master/docs/{$pagesrc}">edit this page</a></li>
> +            </ul>
> +          </div>

I think the "edit this page" link would actually be more prominent
if it were the third one (last one on the left) in the footer rather
than the first one. Please give it a try.

-- 
Andrea Bolognani / Red Hat / Virtualization




More information about the libvir-list mailing list