mirror of
https://github.com/libvirt/libvirt.git
synced 2025-02-25 18:55:26 -06:00
docs: generate API reference pages for admin, qemu & lxc libraries
Reviewed-by: Pavel Hrdina <phrdina@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
parent
fc24f22051
commit
0aa8536f14
@ -35,6 +35,10 @@ modules = \
|
|||||||
virterror \
|
virterror \
|
||||||
$(NULL)
|
$(NULL)
|
||||||
|
|
||||||
|
modules_admin = libvirt-admin
|
||||||
|
modules_qemu = libvirt-qemu
|
||||||
|
modules_lxc = libvirt-lxc
|
||||||
|
|
||||||
apihtml = \
|
apihtml = \
|
||||||
html/index.html \
|
html/index.html \
|
||||||
$(apihtml_generated)
|
$(apihtml_generated)
|
||||||
@ -43,6 +47,30 @@ apihtml_generated = \
|
|||||||
$(addprefix html/libvirt-,$(addsuffix .html,$(modules))) \
|
$(addprefix html/libvirt-,$(addsuffix .html,$(modules))) \
|
||||||
$(NULL)
|
$(NULL)
|
||||||
|
|
||||||
|
apiadminhtml = \
|
||||||
|
html/index-admin.html \
|
||||||
|
$(apiadminhtml_generated)
|
||||||
|
|
||||||
|
apiadminhtml_generated = \
|
||||||
|
$(addprefix html/libvirt-,$(addsuffix .html,$(modules_admin))) \
|
||||||
|
$(NULL)
|
||||||
|
|
||||||
|
apiqemuhtml = \
|
||||||
|
html/index-qemu.html \
|
||||||
|
$(apiqemuhtml_generated)
|
||||||
|
|
||||||
|
apiqemuhtml_generated = \
|
||||||
|
$(addprefix html/libvirt-,$(addsuffix .html,$(modules_qemu))) \
|
||||||
|
$(NULL)
|
||||||
|
|
||||||
|
apilxchtml = \
|
||||||
|
html/index-lxc.html \
|
||||||
|
$(apilxchtml_generated)
|
||||||
|
|
||||||
|
apilxchtml_generated = \
|
||||||
|
$(addprefix html/libvirt-,$(addsuffix .html,$(modules_lxc))) \
|
||||||
|
$(NULL)
|
||||||
|
|
||||||
apipng = \
|
apipng = \
|
||||||
html/left.png \
|
html/left.png \
|
||||||
html/up.png \
|
html/up.png \
|
||||||
@ -50,7 +78,7 @@ apipng = \
|
|||||||
html/right.png
|
html/right.png
|
||||||
|
|
||||||
apirefdir = $(HTML_DIR)/html
|
apirefdir = $(HTML_DIR)/html
|
||||||
apiref_DATA = $(apihtml) $(apipng)
|
apiref_DATA = $(apihtml) $(apiadminhtml) $(apiqemuhtml) $(apilxchtml) $(apipng)
|
||||||
|
|
||||||
css = \
|
css = \
|
||||||
generic.css \
|
generic.css \
|
||||||
@ -188,6 +216,9 @@ aclperms.htmlinc: $(top_srcdir)/src/access/viraccessperm.h \
|
|||||||
CLEANFILES = \
|
CLEANFILES = \
|
||||||
$(dot_html) \
|
$(dot_html) \
|
||||||
$(apihtml) \
|
$(apihtml) \
|
||||||
|
$(apiadminhtml) \
|
||||||
|
$(apiqemuhtml) \
|
||||||
|
$(apilxchtml) \
|
||||||
$(internals_html) \
|
$(internals_html) \
|
||||||
$(kbase_html) \
|
$(kbase_html) \
|
||||||
$(api_DATA) \
|
$(api_DATA) \
|
||||||
@ -252,6 +283,9 @@ EXTRA_DIST += \
|
|||||||
|| { rm $@ && exit 1; }
|
|| { rm $@ && exit 1; }
|
||||||
|
|
||||||
$(apihtml_generated): html/index.html
|
$(apihtml_generated): html/index.html
|
||||||
|
$(apiadminhtml_generated): html/index-admin.html
|
||||||
|
$(apiqemuhtml_generated): html/index-qemu.html
|
||||||
|
$(apilxchtml_generated): html/index-lxc.html
|
||||||
|
|
||||||
html/index.html: libvirt-api.xml newapi.xsl page.xsl $(APIBUILD_STAMP)
|
html/index.html: libvirt-api.xml newapi.xsl page.xsl $(APIBUILD_STAMP)
|
||||||
$(AM_V_GEN)$(XSLTPROC) --nonet -o ./ \
|
$(AM_V_GEN)$(XSLTPROC) --nonet -o ./ \
|
||||||
@ -260,6 +294,14 @@ html/index.html: libvirt-api.xml newapi.xsl page.xsl $(APIBUILD_STAMP)
|
|||||||
$(srcdir)/newapi.xsl libvirt-api.xml && \
|
$(srcdir)/newapi.xsl libvirt-api.xml && \
|
||||||
$(XMLLINT) --nonet --noout html/*.html
|
$(XMLLINT) --nonet --noout html/*.html
|
||||||
|
|
||||||
|
html/index-%.html: libvirt-%-api.xml newapi.xsl page.xsl $(APIBUILD_STAMP)
|
||||||
|
$(AM_V_GEN)$(XSLTPROC) --nonet -o ./ \
|
||||||
|
--stringparam builddir '$(abs_top_builddir)' \
|
||||||
|
--stringparam timestamp $(timestamp) \
|
||||||
|
--stringparam indexfile $(@:html/%=%) \
|
||||||
|
$(srcdir)/newapi.xsl $< && \
|
||||||
|
$(XMLLINT) --nonet --noout html/*.html
|
||||||
|
|
||||||
python_generated_files = \
|
python_generated_files = \
|
||||||
html/libvirt-libvirt-lxc.html \
|
html/libvirt-libvirt-lxc.html \
|
||||||
html/libvirt-libvirt-qemu.html \
|
html/libvirt-libvirt-qemu.html \
|
||||||
|
@ -106,6 +106,10 @@
|
|||||||
<a href="html/libvirt-libvirt-secret.html">secret</a>,
|
<a href="html/libvirt-libvirt-secret.html">secret</a>,
|
||||||
<a href="html/libvirt-libvirt-storage.html">storage</a>,
|
<a href="html/libvirt-libvirt-storage.html">storage</a>,
|
||||||
<a href="html/libvirt-libvirt-stream.html">stream</a>
|
<a href="html/libvirt-libvirt-stream.html">stream</a>
|
||||||
|
and
|
||||||
|
<a href="html/index-admin.html">admin</a>,
|
||||||
|
<a href="html/index-qemu.html">QEMU</a>,
|
||||||
|
<a href="html/index-lxc.html">LXC</a> libs
|
||||||
</dd>
|
</dd>
|
||||||
|
|
||||||
<dt><a href="drivers.html">Drivers</a></dt>
|
<dt><a href="drivers.html">Drivers</a></dt>
|
||||||
|
@ -23,6 +23,7 @@
|
|||||||
<xsl:key name="symbols" match="/api/symbols/*" use="@name"/>
|
<xsl:key name="symbols" match="/api/symbols/*" use="@name"/>
|
||||||
|
|
||||||
<xsl:param name="builddir" select="'..'"/>
|
<xsl:param name="builddir" select="'..'"/>
|
||||||
|
<xsl:param name="indexfile" select="'index.html'"/>
|
||||||
|
|
||||||
<!-- the target directory for the HTML output -->
|
<!-- the target directory for the HTML output -->
|
||||||
<xsl:variable name="htmldir">html</xsl:variable>
|
<xsl:variable name="htmldir">html</xsl:variable>
|
||||||
@ -101,10 +102,10 @@
|
|||||||
<td><a accesskey="p" href="libvirt-{$previous/@name}.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td>
|
<td><a accesskey="p" href="libvirt-{$previous/@name}.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></img></a></td>
|
||||||
<th align="left"><a href="libvirt-{$previous/@name}.html"><xsl:value-of select="$previous/@name"/></a></th>
|
<th align="left"><a href="libvirt-{$previous/@name}.html"><xsl:value-of select="$previous/@name"/></a></th>
|
||||||
</xsl:if>
|
</xsl:if>
|
||||||
<td><a accesskey="u" href="index.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td>
|
<td><a accesskey="u" href="{$indexfile}"><img src="up.png" width="24" height="24" border="0" alt="Up"></img></a></td>
|
||||||
<th align="left"><a href="index.html">API documentation</a></th>
|
<th align="left"><a href="{$indexfile}">API documentation</a></th>
|
||||||
<td><a accesskey="h" href="../index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td>
|
<td><a accesskey="h" href="../{$indexfile}"><img src="home.png" width="24" height="24" border="0" alt="Home"></img></a></td>
|
||||||
<th align="center"><a href="../index.html">The virtualization API</a></th>
|
<th align="center"><a href="../{$indexfile}">The virtualization API</a></th>
|
||||||
<xsl:if test="$next">
|
<xsl:if test="$next">
|
||||||
<th align="right"><a href="libvirt-{$next/@name}.html"><xsl:value-of select="$next/@name"/></a></th>
|
<th align="right"><a href="libvirt-{$next/@name}.html"><xsl:value-of select="$next/@name"/></a></th>
|
||||||
<td><a accesskey="n" href="libvirt-{$next/@name}.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td>
|
<td><a accesskey="n" href="libvirt-{$next/@name}.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></img></a></td>
|
||||||
@ -830,12 +831,12 @@
|
|||||||
<xsl:call-template name="mainpage"/>
|
<xsl:call-template name="mainpage"/>
|
||||||
</xsl:variable>
|
</xsl:variable>
|
||||||
<xsl:document
|
<xsl:document
|
||||||
href="{concat($htmldir, '/index.html')}"
|
href="{concat($htmldir, '/', $indexfile)}"
|
||||||
method="xml"
|
method="xml"
|
||||||
indent="yes"
|
indent="yes"
|
||||||
encoding="UTF-8">
|
encoding="UTF-8">
|
||||||
<xsl:apply-templates select="exsl:node-set($mainpage)" mode="page">
|
<xsl:apply-templates select="exsl:node-set($mainpage)" mode="page">
|
||||||
<xsl:with-param name="pagename" select="concat($htmldir, '/index.html')"/>
|
<xsl:with-param name="pagename" select="concat($htmldir, '', $indexfile)"/>
|
||||||
<xsl:with-param name="timestamp" select="$timestamp"/>
|
<xsl:with-param name="timestamp" select="$timestamp"/>
|
||||||
</xsl:apply-templates>
|
</xsl:apply-templates>
|
||||||
</xsl:document>
|
</xsl:document>
|
||||||
|
Loading…
Reference in New Issue
Block a user