[PATCH] docs: page.xsl: Improve generation of paragraph anchor links

Peter Krempa pkrempa at redhat.com
Mon Oct 26 12:51:53 UTC 2020

Use the 'parent' axis to check whether the parent is a div with
class='section' rather than looking for 'toc-backref' anchor to see
whether to generate one of the headerlink alternatives. Both hare
docutils-specific thus apply to docs generated from RST documents.

This adds the links for pages generated from RST documents which don't
have a table of contents (and thus lack the 'toc-backref' anchors) and
thus fixes pages such as hacking.html and news.html to have reasonable
links which can be shared.

Signed-off-by: Peter Krempa <pkrempa at redhat.com>

Note that whether or not to add table of contents to hacking.rst is out
of scope of this patch.

 docs/page.xsl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/page.xsl b/docs/page.xsl
index 36168305fa..07bfc52a4c 100644
--- a/docs/page.xsl
+++ b/docs/page.xsl
@@ -196,7 +196,7 @@
       <xsl:if test="./html:a/@id">
         <a class="headerlink" href="#{html:a/@id}" title="Permalink to this headline">&#xb6;</a>
-      <xsl:if test="./html:a[@class='toc-backref']">
+      <xsl:if test="parent::html:div[@class='section']">
         <a class="headerlink" href="#{../@id}" title="Permalink to this headline">&#xb6;</a>

More information about the libvir-list mailing list