mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-09-09 01:04:59 +00:00
The rst2html tool is provided by python docutils, and as the name suggests, it converts RST documents into HTML. Basic rules are added for integrating RST docs into the website build process. This enables us to start writing docs on our website in RST format instead of HTML, without changing the rest of our website templating system away from XSLT yet. Reviewed-by: Michal Privoznik <mprivozn@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
403 lines
11 KiB
Makefile
403 lines
11 KiB
Makefile
## Process this file with automake to produce Makefile.in
|
|
|
|
## Copyright (C) 2005-2016 Red Hat, Inc.
|
|
##
|
|
## This library is free software; you can redistribute it and/or
|
|
## modify it under the terms of the GNU Lesser General Public
|
|
## License as published by the Free Software Foundation; either
|
|
## version 2.1 of the License, or (at your option) any later version.
|
|
##
|
|
## This library is distributed in the hope that it will be useful,
|
|
## but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
## Lesser General Public License for more details.
|
|
##
|
|
## You should have received a copy of the GNU Lesser General Public
|
|
## License along with this library. If not, see
|
|
## <http://www.gnu.org/licenses/>.
|
|
|
|
HTML_DIR = $(docdir)/html
|
|
|
|
modules = \
|
|
libvirt-common \
|
|
libvirt-domain \
|
|
libvirt-domain-checkpoint \
|
|
libvirt-domain-snapshot \
|
|
libvirt-event \
|
|
libvirt-host \
|
|
libvirt-interface \
|
|
libvirt-network \
|
|
libvirt-nodedev \
|
|
libvirt-nwfilter \
|
|
libvirt-secret \
|
|
libvirt-storage \
|
|
libvirt-stream \
|
|
virterror \
|
|
$(NULL)
|
|
|
|
modules_admin = libvirt-admin
|
|
modules_qemu = libvirt-qemu
|
|
modules_lxc = libvirt-lxc
|
|
|
|
all: vpathhack
|
|
|
|
# This hack enables us to view the web pages
|
|
# from within the uninstalled build tree
|
|
vpathhack:
|
|
@for dir in fonts js logos; \
|
|
do \
|
|
test -e $$dir || ln -s $(srcdir)/$$dir $$dir ; \
|
|
done
|
|
@for file in $(css); \
|
|
do \
|
|
test -e $$file || ln -s $(srcdir)/$$file $$file ; \
|
|
done
|
|
|
|
clean-local:
|
|
for dir in fonts js logos; \
|
|
do \
|
|
rm -f $$dir ; \
|
|
done
|
|
for file in $(css); \
|
|
do \
|
|
rm -f $$file ; \
|
|
done
|
|
|
|
apihtml = \
|
|
html/index.html \
|
|
$(apihtml_generated)
|
|
|
|
apihtml_generated = \
|
|
$(addprefix html/libvirt-,$(addsuffix .html,$(modules))) \
|
|
$(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 = \
|
|
html/left.png \
|
|
html/up.png \
|
|
html/home.png \
|
|
html/right.png
|
|
|
|
apirefdir = $(HTML_DIR)/html
|
|
apiref_DATA = $(apihtml) $(apiadminhtml) $(apiqemuhtml) $(apilxchtml) $(apipng)
|
|
|
|
css = \
|
|
generic.css \
|
|
libvirt.css \
|
|
mobile.css \
|
|
main.css
|
|
|
|
javascript = \
|
|
js/main.js \
|
|
$(NULL)
|
|
|
|
javascriptdir = $(HTML_DIR)/js
|
|
javascript_DATA = $(javascript)
|
|
|
|
fonts = \
|
|
fonts/LICENSE.md \
|
|
fonts/stylesheet.css \
|
|
fonts/overpass-bold-italic.woff \
|
|
fonts/overpass-bold.woff \
|
|
fonts/overpass-italic.woff \
|
|
fonts/overpass-light-italic.woff \
|
|
fonts/overpass-light.woff \
|
|
fonts/overpass-mono-bold.woff \
|
|
fonts/overpass-mono-light.woff \
|
|
fonts/overpass-mono-regular.woff \
|
|
fonts/overpass-mono-semibold.woff \
|
|
fonts/overpass-regular.woff
|
|
|
|
fontsdir = $(HTML_DIR)/fonts
|
|
fonts_DATA = $(fonts)
|
|
|
|
logofiles = \
|
|
logos/logo-base.svg \
|
|
logos/logo-square.svg \
|
|
logos/logo-square-powered.svg \
|
|
logos/logo-banner-dark.svg \
|
|
logos/logo-banner-light.svg \
|
|
logos/logo-square-96.png \
|
|
logos/logo-square-128.png \
|
|
logos/logo-square-192.png \
|
|
logos/logo-square-256.png \
|
|
logos/logo-square-powered-96.png \
|
|
logos/logo-square-powered-128.png \
|
|
logos/logo-square-powered-192.png \
|
|
logos/logo-square-powered-256.png \
|
|
logos/logo-banner-dark-256.png \
|
|
logos/logo-banner-dark-800.png \
|
|
logos/logo-banner-light-256.png \
|
|
logos/logo-banner-light-800.png
|
|
|
|
logofilesdir = $(HTML_DIR)/logos
|
|
logofiles_DATA = $(logofiles)
|
|
|
|
png = \
|
|
32favicon.png \
|
|
libvirt-daemon-arch.png \
|
|
libvirt-driver-arch.png \
|
|
libvirt-object-model.png \
|
|
migration-managed-direct.png \
|
|
migration-managed-p2p.png \
|
|
migration-native.png \
|
|
migration-tunnel.png \
|
|
migration-unmanaged-direct.png
|
|
|
|
gif = \
|
|
architecture.gif \
|
|
node.gif
|
|
|
|
internals_html_in = \
|
|
$(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/internals/*.html.in))
|
|
kbase_rst = \
|
|
$(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/kbase/*.rst))
|
|
kbase_rst_html_in = \
|
|
$(kbase_rst:%.rst=%.html.in)
|
|
internals_html = \
|
|
$(internals_html_in:%.html.in=%.html) \
|
|
$(internals_rst_html_in:%.html.in=%.html)
|
|
|
|
internalsdir = $(HTML_DIR)/internals
|
|
internals_DATA = $(internals_html)
|
|
|
|
kbase_html_in = \
|
|
$(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/kbase/*.html.in))
|
|
kbase_rst = \
|
|
$(patsubst $(srcdir)/%,%,$(wildcard $(srcdir)/kbase/*.rst))
|
|
kbase_rst_html_in = \
|
|
$(kbase_rst:%.rst=%.html.in)
|
|
kbase_html = \
|
|
$(kbase_html_in:%.html.in=%.html) \
|
|
$(kbase_rst_html_in:%.html.in=%.html)
|
|
|
|
kbasedir = $(HTML_DIR)/kbase
|
|
kbase_DATA = $(kbase_html)
|
|
|
|
# Generate hvsupport.html and news.html first, since they take one extra step.
|
|
dot_html_generated_in = \
|
|
hvsupport.html.in \
|
|
news.html.in
|
|
dot_html_in = \
|
|
$(notdir $(wildcard $(srcdir)/*.html.in))
|
|
dot_rst = \
|
|
$(notdir $(wildcard $(srcdir)/*.rst))
|
|
dot_rst_html_in = \
|
|
$(dot_rst:%.rst=%.html)
|
|
dot_html = \
|
|
$(dot_html_generated_in:%.html.in=%.html) \
|
|
$(dot_html_in:%.html.in=%.html) \
|
|
$(dot_rst_html_in:%.html.in=%.html)
|
|
|
|
htmldir = $(HTML_DIR)
|
|
html_DATA = $(css) $(png) $(gif) $(dot_html)
|
|
|
|
apidir = $(pkgdatadir)/api
|
|
api_DATA = \
|
|
libvirt-api.xml \
|
|
libvirt-qemu-api.xml \
|
|
libvirt-lxc-api.xml \
|
|
libvirt-admin-api.xml
|
|
|
|
fig = \
|
|
libvirt-daemon-arch.fig \
|
|
libvirt-driver-arch.fig \
|
|
libvirt-object-model.fig \
|
|
migration-managed-direct.fig \
|
|
migration-managed-p2p.fig \
|
|
migration-native.fig \
|
|
migration-tunnel.fig \
|
|
migration-unmanaged-direct.fig
|
|
|
|
schemadir = $(pkgdatadir)/schemas
|
|
schema_DATA = $(wildcard $(srcdir)/schemas/*.rng)
|
|
|
|
EXTRA_DIST= \
|
|
genaclperms.pl \
|
|
site.xsl subsite.xsl newapi.xsl page.xsl \
|
|
wrapstring.xsl \
|
|
$(dot_html_in) $(dot_rst) $(gif) $(apipng) \
|
|
$(fig) $(png) $(css) \
|
|
$(javascript) $(logofiles) \
|
|
$(internals_html_in) $(internals_rst) $(fonts) \
|
|
$(kbase_html_in) $(kbase_rst) \
|
|
aclperms.htmlinc \
|
|
hvsupport.pl \
|
|
$(schema_DATA)
|
|
|
|
acl_generated = aclperms.htmlinc
|
|
|
|
aclperms.htmlinc: $(top_srcdir)/src/access/viraccessperm.h \
|
|
$(srcdir)/genaclperms.pl Makefile.am
|
|
$(AM_V_GEN)$(PERL) $(srcdir)/genaclperms.pl $< > $@
|
|
|
|
CLEANFILES = \
|
|
$(dot_html) \
|
|
$(apihtml) \
|
|
$(apiadminhtml) \
|
|
$(apiqemuhtml) \
|
|
$(apilxchtml) \
|
|
$(internals_html) \
|
|
$(kbase_html) \
|
|
$(api_DATA) \
|
|
$(dot_html_generated_in) \
|
|
aclperms.htmlinc
|
|
|
|
timestamp="$(shell if test -n "$$SOURCE_DATE_EPOCH"; \
|
|
then \
|
|
date -u --date="@$$SOURCE_DATE_EPOCH"; \
|
|
else \
|
|
date -u; \
|
|
fi)"
|
|
|
|
hvsupport.html: hvsupport.html.in
|
|
|
|
hvsupport.html.in: $(srcdir)/hvsupport.pl $(api_DATA) \
|
|
$(top_srcdir)/src/libvirt_public.syms \
|
|
$(top_srcdir)/src/libvirt_qemu.syms $(top_srcdir)/src/libvirt_lxc.syms \
|
|
$(top_srcdir)/src/driver.h
|
|
$(AM_V_GEN)$(PERL) $(srcdir)/hvsupport.pl $(top_srcdir) $(top_builddir) > $@ \
|
|
|| { rm $@ && exit 1; }
|
|
|
|
news.html.in: \
|
|
$(srcdir)/news.xml \
|
|
$(srcdir)/news-html.xsl
|
|
$(AM_V_GEN)$(XSLTPROC) --nonet \
|
|
$(srcdir)/news-html.xsl \
|
|
$(srcdir)/news.xml \
|
|
>$@ \
|
|
|| { rm -f $@; exit 1; };
|
|
EXTRA_DIST += \
|
|
$(srcdir)/news.xml \
|
|
$(srcdir)/news.rng \
|
|
$(srcdir)/news-html.xsl
|
|
|
|
%.png: %.fig
|
|
convert -rotate 90 $< $@
|
|
|
|
%.html.in: %.rst
|
|
$(AM_V_GEN)$(MKDIR_P) `dirname $@` && \
|
|
$(RST2HTML) $< > $@
|
|
|
|
%.html.tmp: %.html.in site.xsl subsite.xsl page.xsl \
|
|
$(acl_generated)
|
|
$(AM_V_GEN)name=`echo $@ | sed -e 's/.tmp//'`; \
|
|
dir=`dirname $@` ; \
|
|
if test "$$dir" = "."; \
|
|
then \
|
|
style=site.xsl; \
|
|
else \
|
|
$(MKDIR_P) $$dir; \
|
|
style=subsite.xsl; \
|
|
fi; \
|
|
$(XSLTPROC) --stringparam pagename $$name \
|
|
--stringparam builddir '$(abs_top_builddir)' \
|
|
--stringparam timestamp $(timestamp) --nonet \
|
|
$(top_srcdir)/docs/$$style $< > $@ \
|
|
|| { rm $@ && exit 1; }
|
|
|
|
%.html: %.html.tmp
|
|
$(AM_V_GEN)$(XMLLINT) --nonet --format $< > $@ \
|
|
|| { rm $@ && exit 1; }
|
|
|
|
$(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)
|
|
$(AM_V_GEN)$(XSLTPROC) --nonet -o ./ \
|
|
--stringparam builddir '$(abs_top_builddir)' \
|
|
--stringparam timestamp $(timestamp) \
|
|
$(srcdir)/newapi.xsl libvirt-api.xml
|
|
|
|
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 $<
|
|
|
|
check-html:
|
|
$(XMLLINT) --nonet --noout html/*.html
|
|
|
|
check-local: check-html
|
|
|
|
python_generated_files = \
|
|
html/libvirt-libvirt-lxc.html \
|
|
html/libvirt-libvirt-qemu.html \
|
|
html/libvirt-libvirt-admin.html \
|
|
html/libvirt-virterror.html \
|
|
$(api_DATA) \
|
|
$(NULL)
|
|
|
|
APIBUILD=$(top_srcdir)/scripts/apibuild.py
|
|
APIBUILD_STAMP=apibuild.py.stamp
|
|
CLEANFILES += $(APIBUILD_STAMP)
|
|
|
|
$(python_generated_files): $(APIBUILD_STAMP)
|
|
|
|
$(APIBUILD_STAMP): $(top_srcdir)/scripts/apibuild.py \
|
|
$(top_srcdir)/include/libvirt/libvirt.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-common.h.in \
|
|
$(top_srcdir)/include/libvirt/libvirt-domain-checkpoint.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-domain-snapshot.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-domain.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-event.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-host.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-interface.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-network.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-nodedev.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-nwfilter.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-secret.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-storage.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-stream.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-lxc.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-qemu.h \
|
|
$(top_srcdir)/include/libvirt/libvirt-admin.h \
|
|
$(top_srcdir)/include/libvirt/virterror.h \
|
|
$(top_srcdir)/src/libvirt.c \
|
|
$(top_srcdir)/src/libvirt-domain-checkpoint.c \
|
|
$(top_srcdir)/src/libvirt-domain-snapshot.c \
|
|
$(top_srcdir)/src/libvirt-domain.c \
|
|
$(top_srcdir)/src/libvirt-host.c \
|
|
$(top_srcdir)/src/libvirt-interface.c \
|
|
$(top_srcdir)/src/libvirt-network.c \
|
|
$(top_srcdir)/src/libvirt-nodedev.c \
|
|
$(top_srcdir)/src/libvirt-nwfilter.c \
|
|
$(top_srcdir)/src/libvirt-secret.c \
|
|
$(top_srcdir)/src/libvirt-storage.c \
|
|
$(top_srcdir)/src/libvirt-stream.c \
|
|
$(top_srcdir)/src/libvirt-lxc.c \
|
|
$(top_srcdir)/src/libvirt-qemu.c \
|
|
$(top_srcdir)/src/admin/libvirt-admin.c \
|
|
$(top_srcdir)/src/util/virerror.c \
|
|
$(top_srcdir)/src/util/virevent.c \
|
|
$(top_srcdir)/src/util/virtypedparam-public.c
|
|
$(AM_V_GEN)srcdir=$(srcdir) builddir=$(builddir) \
|
|
$(RUNUTF8) $(PYTHON) $(APIBUILD)
|
|
touch $@
|