From nobody Mon Sep 16 19:51:22 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) client-ip=170.10.129.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1684337384; cv=none; d=zohomail.com; s=zohoarc; b=Nf3XGf8MKQIRVwFhgPMi3dS9ErYqJuX/90dEFysQbf/+1xTQNtHe/XD01OH2FLxe2hGKwov+MaoIHBv6dANARluy77wobR1SHzC4y66YzjmFAKn4LBggMN6yjat35qngDzzCD+9HzizqyVVIlwwhQnQLdLXpB/rVpJv7mP8AAHQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1684337384; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=iXotWCH6YpLf96miMuTxsoEeLg51dA0P8JT+lJuvgwo=; b=dHkVqAnxXMa2jUCJtWm81If80tBKc1CQM1gijqWzIkr8ke5ckLIk9XVxZpFdwWmcbmuxXaV0uYep0NFuUP9lYhiKO8XZrL1yeloKn9HqLYmgcogsBYJ6iGhqDPDE4ynYsv3A9m6vwTldnnFCgTiW0D6yPlIAe3mt4k4usl3VM04= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.129.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mx.zohomail.com with SMTPS id 1684337384342135.12473979506626; Wed, 17 May 2023 08:29:44 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-85-QrrY7NKCPjGhBh1sMhKnCg-1; Wed, 17 May 2023 11:28:52 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B643A2A2AD7D; Wed, 17 May 2023 15:28:27 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (unknown [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id A2E2D2026D25; Wed, 17 May 2023 15:28:27 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 93A7519465A8; Wed, 17 May 2023 15:28:27 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id EFE6919465A8 for ; Wed, 17 May 2023 15:28:26 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id E2628C164E8; Wed, 17 May 2023 15:28:26 +0000 (UTC) Received: from speedmetal.lan (unknown [10.45.242.22]) by smtp.corp.redhat.com (Postfix) with ESMTP id 62376C16046 for ; Wed, 17 May 2023 15:28:26 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1684337383; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=iXotWCH6YpLf96miMuTxsoEeLg51dA0P8JT+lJuvgwo=; b=Wvt0Jj/2NdSVz43QRcT2Apts6lXSXGcrzdzxf/LnnNlhNsllo1uzrgPE9ibxJe9Ir3s62F bGSvvdXp0xFWyrirs2XO8EbVwhojIo+6euKGbqy+hPdMrC/a/OLxjr19D89T+WpLwxTxET 31kqFtE1+zX86gRrDp5v8zV/VXUfSww= X-MC-Unique: QrrY7NKCPjGhBh1sMhKnCg-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Peter Krempa To: libvir-list@redhat.com Subject: [PATCH 5/7] docs: html: Add a manually written index page Date: Wed, 17 May 2023 17:28:19 +0200 Message-Id: <46aa8dcdf6a739205ca7f6e9081a8fd1eb965f90.1684336381.git.pkrempa@redhat.com> In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.8 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 3.1 on 10.11.54.4 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1684337384608100002 Content-Type: text/plain; charset="utf-8" The auto-generated index contains only references to one run of the generator but we in total run it 4 times missing the admin, lxc, and qemu specific apis. Rewrite it manually so that we can drop the generator for it. Signed-off-by: Peter Krempa --- docs/html/index.rst | 65 +++++++++++++++++++++++++++++++++++++++++++ docs/html/meson.build | 46 ++++++++++++++++++++++++++++-- 2 files changed, 109 insertions(+), 2 deletions(-) create mode 100644 docs/html/index.rst diff --git a/docs/html/index.rst b/docs/html/index.rst new file mode 100644 index 0000000000..7977ec1f05 --- /dev/null +++ b/docs/html/index.rst @@ -0,0 +1,65 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D +Reference Manual for libvirt +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +.. contents:: + +Main libvirt APIs +----------------- + +`libvirt-common `__ + common macros and enums for the libvirt and libvirt-admin library + +`libvirt-domain-checkpoint `__ + APIs for management of domain checkpoints + +`libvirt-domain-snapshot `__ + APIs for management of domain snapshots + +`libvirt-domain `__ + APIs for management of domains + +`libvirt-event `__ + APIs for management of events + +`libvirt-host `__ + APIs for management of hosts + +`libvirt-interface `__ + APIs for management of interfaces + +`libvirt-network `__ + APIs for management of networks + +`libvirt-nodedev `__ + APIs for management of nodedevs + +`libvirt-nwfilter `__ + APIs for management of nwfilters + +`libvirt-secret `__ + APIs for management of secrets + +`libvirt-storage `__ + APIs for management of storage pools and volumes + +`libvirt-stream `__ + APIs for management of streams + +Error handling +-------------- + +`virterror `__ + error handling interfaces for the libvirt library + +Special specific APIs +--------------------- + +`admin interface `__ + APIs for management of the libvirt daemons + +`qemu driver `__ + qemu-driver specific APIs + +`lxc driver `__ + lxc-driver specific APIs diff --git a/docs/html/meson.build b/docs/html/meson.build index b18a8ccb5f..4d8d44d783 100644 --- a/docs/html/meson.build +++ b/docs/html/meson.build @@ -8,7 +8,6 @@ index_api_gen =3D custom_target( docs_api_xml, ], output: [ - 'index.html', 'libvirt-libvirt-common.html', 'libvirt-libvirt-domain.html', 'libvirt-libvirt-domain-checkpoint.html', @@ -28,7 +27,6 @@ index_api_gen =3D custom_target( xsltproc_prog, '--nonet', '-o', docs_builddir, '--stringparam', 'builddir', meson.project_build_root(), '--stringparam', 'timestamp', docs_timestamp, - '--stringparam', 'indexfile', 'index.html', '@INPUT@', ], install: true, @@ -77,6 +75,50 @@ foreach file : docs_html_gen install_web_files +=3D '@0@:@1@'.format(file.full_path(), docs_html_dir = / 'html') endforeach +html_xslt_gen_install_dir =3D docs_html_dir / 'html' +html_xslt_gen =3D [] + +html_xslt_gen +=3D { + 'name': 'index', + 'file': docs_rst2html5_gen.process('index.rst'), + 'source': 'docs' / 'html' / 'index.rst', + 'href_base': '../', + } + +# --- begin of XSLT processing --- + +foreach data : html_xslt_gen + html_filename =3D data['name'] + '.html' + + html_file =3D custom_target( + html_filename, + input: data.get('file', data['name'] + '.html.in'), + output: html_filename, + command: [ + xsltproc_prog, + '--stringparam', 'pagesrc', data.get('source', ''), + '--stringparam', 'builddir', meson.project_build_root(), + '--stringparam', 'timestamp', docs_timestamp, + '--stringparam', 'href_base', data.get('href_base', ''), + '--nonet', + site_xsl, + '@INPUT@', + ], + depends: data.get('depends', []), + depend_files: [ page_xsl ], + capture: true, + install: true, + install_dir: html_xslt_gen_install_dir, + ) + + install_web_deps +=3D html_file + install_web_files +=3D html_file.full_path() + ':' + html_xslt_gen_insta= ll_dir +endforeach + +html_xslt_gen =3D [] + +# --- end of XSLT processing --- + test( 'check-html', xmllint_prog, --=20 2.40.1