[PATCH 0/4] docs: Move 'golang' metadata headers into rST files and further XSL cleanups
Pipeline: https://gitlab.com/pipo.sk/libvirt/-/jobs/4385932520 Impacted HTML files from pipeline: https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/libv... https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/libv... https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/go/l... https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/go/l... Peter Krempa (4): docs: newapi: Remove unused 'docomponents' template docs: page.xsl: Drop passhrough of <script> elements into header docs: go: Add 'go-import' metadata via rST docs: Use '--exit-status=' option for 'rst2html5' docs/go/libvirt.rst | 3 +++ docs/go/libvirtxml.rst | 3 +++ docs/libvirt-go-xml.rst | 3 +++ docs/libvirt-go.rst | 3 +++ docs/meson.build | 2 +- docs/newapi.xsl | 18 ------------------ docs/page.xsl | 14 ++------------ 7 files changed, 15 insertions(+), 31 deletions(-) -- 2.40.1
Never used since introduction in b38893c3eaa56617a3ef313c45e505da6e50 Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/newapi.xsl | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/docs/newapi.xsl b/docs/newapi.xsl index cafe49f61f..19a440bb09 100644 --- a/docs/newapi.xsl +++ b/docs/newapi.xsl @@ -733,24 +733,6 @@ </xsl:if> </xsl:template> - <xsl:template name="docomponents"> - <xsl:apply-templates select="exports[@type='macro']"> - <xsl:sort select='@symbol'/> - </xsl:apply-templates> - <xsl:apply-templates select="exports[@type='enum']"> - <xsl:sort select='@symbol'/> - </xsl:apply-templates> - <xsl:apply-templates select="exports[@type='typedef']"> - <xsl:sort select='@symbol'/> - </xsl:apply-templates> - <xsl:apply-templates select="exports[@type='struct']"> - <xsl:sort select='@symbol'/> - </xsl:apply-templates> - <xsl:apply-templates select="exports[@type='function']"> - <xsl:sort select='@symbol'/> - </xsl:apply-templates> - </xsl:template> - <xsl:template match="file"> <xsl:variable name="name" select="@name"/> <xsl:variable name="title">Module <xsl:value-of select="$name"/> from <xsl:value-of select="/api/@name"/></xsl:variable> -- 2.40.1
No generated headers have inline javascript. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/page.xsl | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/page.xsl b/docs/page.xsl index c92ceffec7..e3112fc9f8 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -56,7 +56,6 @@ <xsl:if test="$pagesrc = 'docs/go/libvirtxml.rst'"> <meta name="go-import" content="libvirt.org/go/libvirtxml git https://gitlab.com/libvirt/libvirt-go-xml-module.git"/> </xsl:if> - <xsl:apply-templates select="/html:html/html:head/html:script" mode="content"/> <script type="text/javascript" src="{$href_base}js/main.js"> <xsl:comment>// forces non-empty element</xsl:comment> -- 2.40.1
The '.. meta::' rST directive allows adding header metadata. Move the specific metadata from page.xsl into the individual files and pass them trhough into the header from page.xsl. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/go/libvirt.rst | 3 +++ docs/go/libvirtxml.rst | 3 +++ docs/libvirt-go-xml.rst | 3 +++ docs/libvirt-go.rst | 3 +++ docs/page.xsl | 13 ++----------- 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/go/libvirt.rst b/docs/go/libvirt.rst index 6a1344ad3e..09eaa66714 100644 --- a/docs/go/libvirt.rst +++ b/docs/go/libvirt.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/go/libvirt git https://gitlab.com/libvirt/libvirt-go-module.git + ========================================= Libvirt Go Language API (with Go modules) ========================================= diff --git a/docs/go/libvirtxml.rst b/docs/go/libvirtxml.rst index 5407d609f2..315499da1a 100644 --- a/docs/go/libvirtxml.rst +++ b/docs/go/libvirtxml.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/go/libvirtxml git https://gitlab.com/libvirt/libvirt-go-xml-module.git + ============================================ Libvirt Go XML parsing API (with Go modules) ============================================ diff --git a/docs/libvirt-go-xml.rst b/docs/libvirt-go-xml.rst index d2a488d99d..822dc73638 100644 --- a/docs/libvirt-go-xml.rst +++ b/docs/libvirt-go-xml.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/libvirt-go-xml git https://gitlab.com/libvirt/libvirt-go-xml.git + =================================================== Obsolete libvirt Go XML parsing API (no Go modules) =================================================== diff --git a/docs/libvirt-go.rst b/docs/libvirt-go.rst index 85ee3191b5..60ec9fbbb2 100644 --- a/docs/libvirt-go.rst +++ b/docs/libvirt-go.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/libvirt-go git https://gitlab.com/libvirt/libvirt-go.git + ================================================ Obsolete libvirt Go Language API (no Go modules) ================================================ diff --git a/docs/page.xsl b/docs/page.xsl index e3112fc9f8..27607e4d92 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -44,17 +44,8 @@ <meta name="theme-color" content="#ffffff"/> <title>libvirt: <xsl:value-of select="html:html/html:body//html:h1"/></title> <meta name="description" content="libvirt, virtualization, virtualization API"/> - <xsl:if test="$pagesrc = 'docs/libvirt-go.rst'"> - <meta name="go-import" content="libvirt.org/libvirt-go git https://gitlab.com/libvirt/libvirt-go.git"/> - </xsl:if> - <xsl:if test="$pagesrc = 'docs/libvirt-go-xml.rst'"> - <meta name="go-import" content="libvirt.org/libvirt-go-xml git https://gitlab.com/libvirt/libvirt-go-xml.git"/> - </xsl:if> - <xsl:if test="$pagesrc = 'docs/go/libvirt.rst'"> - <meta name="go-import" content="libvirt.org/go/libvirt git https://gitlab.com/libvirt/libvirt-go-module.git"/> - </xsl:if> - <xsl:if test="$pagesrc = 'docs/go/libvirtxml.rst'"> - <meta name="go-import" content="libvirt.org/go/libvirtxml git https://gitlab.com/libvirt/libvirt-go-xml-module.git"/> + <xsl:if test="/html:html/html:head/html:meta[@name='go-import']"> + <meta name="go-import" content="{/html:html/html:head/html:meta[@name='go-import']/@content}"/> </xsl:if> <script type="text/javascript" src="{$href_base}js/main.js"> -- 2.40.1
On Wed, May 31, 2023 at 05:08:36PM +0200, Peter Krempa wrote:
The '.. meta::' rST directive allows adding header metadata. Move the specific metadata from page.xsl into the individual files and pass them trhough into the header from page.xsl.
through
Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/go/libvirt.rst | 3 +++ docs/go/libvirtxml.rst | 3 +++ docs/libvirt-go-xml.rst | 3 +++ docs/libvirt-go.rst | 3 +++ docs/page.xsl | 13 ++----------- 5 files changed, 14 insertions(+), 11 deletions(-)
diff --git a/docs/go/libvirt.rst b/docs/go/libvirt.rst index 6a1344ad3e..09eaa66714 100644 --- a/docs/go/libvirt.rst +++ b/docs/go/libvirt.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/go/libvirt git https://gitlab.com/libvirt/libvirt-go-module.git + ========================================= Libvirt Go Language API (with Go modules) ========================================= diff --git a/docs/go/libvirtxml.rst b/docs/go/libvirtxml.rst index 5407d609f2..315499da1a 100644 --- a/docs/go/libvirtxml.rst +++ b/docs/go/libvirtxml.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/go/libvirtxml git https://gitlab.com/libvirt/libvirt-go-xml-module.git + ============================================ Libvirt Go XML parsing API (with Go modules) ============================================ diff --git a/docs/libvirt-go-xml.rst b/docs/libvirt-go-xml.rst index d2a488d99d..822dc73638 100644 --- a/docs/libvirt-go-xml.rst +++ b/docs/libvirt-go-xml.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/libvirt-go-xml git https://gitlab.com/libvirt/libvirt-go-xml.git + =================================================== Obsolete libvirt Go XML parsing API (no Go modules) =================================================== diff --git a/docs/libvirt-go.rst b/docs/libvirt-go.rst index 85ee3191b5..60ec9fbbb2 100644 --- a/docs/libvirt-go.rst +++ b/docs/libvirt-go.rst @@ -1,3 +1,6 @@ +.. meta:: + :go-import: libvirt.org/libvirt-go git https://gitlab.com/libvirt/libvirt-go.git + ================================================ Obsolete libvirt Go Language API (no Go modules) ================================================ diff --git a/docs/page.xsl b/docs/page.xsl index e3112fc9f8..27607e4d92 100644 --- a/docs/page.xsl +++ b/docs/page.xsl @@ -44,17 +44,8 @@ <meta name="theme-color" content="#ffffff"/> <title>libvirt: <xsl:value-of select="html:html/html:body//html:h1"/></title> <meta name="description" content="libvirt, virtualization, virtualization API"/> - <xsl:if test="$pagesrc = 'docs/libvirt-go.rst'"> - <meta name="go-import" content="libvirt.org/libvirt-go git https://gitlab.com/libvirt/libvirt-go.git"/> - </xsl:if> - <xsl:if test="$pagesrc = 'docs/libvirt-go-xml.rst'"> - <meta name="go-import" content="libvirt.org/libvirt-go-xml git https://gitlab.com/libvirt/libvirt-go-xml.git"/> - </xsl:if> - <xsl:if test="$pagesrc = 'docs/go/libvirt.rst'"> - <meta name="go-import" content="libvirt.org/go/libvirt git https://gitlab.com/libvirt/libvirt-go-module.git"/> - </xsl:if> - <xsl:if test="$pagesrc = 'docs/go/libvirtxml.rst'"> - <meta name="go-import" content="libvirt.org/go/libvirtxml git https://gitlab.com/libvirt/libvirt-go-xml-module.git"/> + <xsl:if test="/html:html/html:head/html:meta[@name='go-import']"> + <meta name="go-import" content="{/html:html/html:head/html:meta[@name='go-import']/@content}"/> </xsl:if>
<script type="text/javascript" src="{$href_base}js/main.js"> -- 2.40.1
Ensure that also 'non-halting' messages stop the build process. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/meson.build | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/meson.build b/docs/meson.build index 2f0ecb2272..201fd4c984 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -210,7 +210,7 @@ endif docs_rst2html5_gen = generator( rst2html5_prog, output: '@BASENAME@.html.in', - arguments: [ '--stylesheet=', '--strict', '@INPUT@' ], + arguments: [ '--exit-status=1', '--stylesheet=', '--strict', '@INPUT@' ], capture: true, ) -- 2.40.1
On Wed, May 31, 2023 at 05:08:33PM +0200, Peter Krempa wrote:
Pipeline: https://gitlab.com/pipo.sk/libvirt/-/jobs/4385932520
Impacted HTML files from pipeline: https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/libv... https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/libv... https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/go/l... https://pipo.sk.gitlab.io/-/libvirt/-/jobs/4385932520/artifacts/website/go/l...
Peter Krempa (4): docs: newapi: Remove unused 'docomponents' template docs: page.xsl: Drop passhrough of <script> elements into header docs: go: Add 'go-import' metadata via rST docs: Use '--exit-status=' option for 'rst2html5'
Reviewed-by: Martin Kletzander <mkletzan@redhat.com> with the typo fixed.
docs/go/libvirt.rst | 3 +++ docs/go/libvirtxml.rst | 3 +++ docs/libvirt-go-xml.rst | 3 +++ docs/libvirt-go.rst | 3 +++ docs/meson.build | 2 +- docs/newapi.xsl | 18 ------------------ docs/page.xsl | 14 ++------------ 7 files changed, 15 insertions(+), 31 deletions(-)
-- 2.40.1
participants (2)
-
Martin Kletzander -
Peter Krempa