[PATCH 04/11] docs: Convert 'docs' index page to rst
Peter Krempa
pkrempa at redhat.com
Thu Apr 7 14:00:26 UTC 2022
Along with the conversion we need to adapt the stylesheets to apply to
the new document similarly to how we do that in the knowledge base.
Note that one visible difference is that now a 'Documentation' heading
is visible on top of the page.
Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
docs/css/libvirt.css | 17 ++--
docs/docs.html.in | 188 -------------------------------------------
docs/docs.rst | 175 ++++++++++++++++++++++++++++++++++++++++
docs/meson.build | 2 +-
4 files changed, 188 insertions(+), 194 deletions(-)
delete mode 100644 docs/docs.html.in
create mode 100644 docs/docs.rst
diff --git a/docs/css/libvirt.css b/docs/css/libvirt.css
index b08271ea4d..2ae80f8595 100644
--- a/docs/css/libvirt.css
+++ b/docs/css/libvirt.css
@@ -105,8 +105,8 @@
}
#index.document,
-#docs.document,
#hvsupport.document,
+#documentation.document,
#knowledge-base.document
{
width: inherit;
@@ -397,6 +397,7 @@ h6:hover > a.headerlink {
}
div.panel,
+#documentation .section,
#knowledge-base .section
{
width: 24%;
@@ -406,6 +407,7 @@ div.panel,
}
div.panel h2,
+#documentation .section h1,
#knowledge-base .section h1 {
margin-top: 0px;
padding: 0.5em;
@@ -423,15 +425,12 @@ div.panel h2,
height: 300px;
}
+#documentation.document > h1,
#knowledge-base.document > h1 {
text-align: center;
padding: 1em;
}
-#docs.document h1 {
- visibility: hidden;
-}
-
br.clear {
clear: both;
border: 0px;
@@ -485,11 +484,13 @@ br.clear {
}
div.panel dd,
+#documentation dd,
#knowledge-base dd {
font-size: smaller;
}
div.panel a,
+#documentation a,
#knowledge-base a {
text-decoration: none;
}
@@ -497,6 +498,9 @@ div.panel a,
div.panel ul,
div.panel p,
div.panel dl,
+#documentation ul,
+#documentation p,
+#documentation dl,
#knowledge-base ul,
#knowledge-base p,
#knowledge-base dl {
@@ -505,16 +509,19 @@ div.panel dl,
}
div.panel ul,
+#documentation ul,
#knowledge-base ul {
margin-left: 1em;
}
div.panel dt,
+#documentation dt,
#knowledge-base dt {
margin: 0px;
}
div.panel dd,
+#documentation dd,
#knowledge-base dd {
margin: 0px;
margin-bottom: 1em;
diff --git a/docs/docs.html.in b/docs/docs.html.in
deleted file mode 100644
index ff7a95fae7..0000000000
--- a/docs/docs.html.in
+++ /dev/null
@@ -1,188 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
- <body id="docs">
- <h1>Documentation</h1>
- <div class="panel">
- <h2>Deployment / operation</h2>
-
- <dl>
- <dt><a href="apps.html">Applications</a></dt>
- <dd>Applications known to use libvirt</dd>
-
- <dt><a href="manpages/index.html">Manual pages</a></dt>
- <dd>Manual pages for libvirt tools / daemons</dd>
-
- <dt><a href="windows.html">Windows</a></dt>
- <dd>Downloads for Windows</dd>
-
- <dt><a href="macos.html">macOS</a></dt>
- <dd>Working with libvirt on macOS</dd>
-
- <dt><a href="migration.html">Migration</a></dt>
- <dd>Migrating guests between machines</dd>
-
- <dt><a href="daemons.html">Daemons</a></dt>
- <dd>Overview of the daemons provided by libvirt</dd>
-
- <dt><a href="remote.html">Remote access</a></dt>
- <dd>Enable remote access over TCP</dd>
-
- <dt><a href="auth.html">Authentication</a></dt>
- <dd>Configure authentication for the libvirt daemon</dd>
-
- <dt><a href="acl.html">Access control</a></dt>
- <dd>Configure access control libvirt APIs with <a href="aclpolkit.html">polkit</a></dd>
-
- <dt><a href="logging.html">Logging</a></dt>
- <dd>The library and the daemon logging support</dd>
-
- <dt><a href="auditlog.html">Audit log</a></dt>
- <dd>Audit trail logs for host operations</dd>
-
- <dt><a href="firewall.html">Firewall</a></dt>
- <dd>Firewall and network filter configuration</dd>
-
- <dt><a href="hooks.html">Hooks</a></dt>
- <dd>Hooks for system specific management</dd>
-
- <dt><a href="nss.html">NSS module</a></dt>
- <dd>Enable domain host name translation to IP addresses</dd>
-
- <dt><a href="https://wiki.libvirt.org/page/FAQ">FAQ</a></dt>
- <dd>Frequently asked questions</dd>
- </dl>
-
- </div>
-
- <div class="panel">
- <h2>Application development</h2>
- <dl>
- <dt><a href="html/index.html">API reference</a></dt>
- <dd>Reference manual for the C public API, split in
- <a href="html/libvirt-libvirt-common.html">common</a>,
- <a href="html/libvirt-libvirt-domain.html">domain</a>,
- <a href="html/libvirt-libvirt-domain-checkpoint.html">domain checkpoint</a>,
- <a href="html/libvirt-libvirt-domain-snapshot.html">domain snapshot</a>,
- <a href="html/libvirt-virterror.html">error</a>,
- <a href="html/libvirt-libvirt-event.html">event</a>,
- <a href="html/libvirt-libvirt-host.html">host</a>,
- <a href="html/libvirt-libvirt-interface.html">interface</a>,
- <a href="html/libvirt-libvirt-network.html">network</a>,
- <a href="html/libvirt-libvirt-nodedev.html">node device</a>,
- <a href="html/libvirt-libvirt-nwfilter.html">network filter</a>,
- <a href="html/libvirt-libvirt-secret.html">secret</a>,
- <a href="html/libvirt-libvirt-storage.html">storage</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>
-
- <dt><a href="bindings.html">Language bindings and API modules</a></dt>
- <dd>Bindings of the libvirt API for
- <a href="csharp.html">c#</a>,
- <a href="https://pkg.go.dev/libvirt.org/go/libvirt">go</a>,
- <a href="java.html">java</a>,
- <a href="https://libvirt.org/ocaml/">ocaml</a>,
- <a href="https://search.cpan.org/dist/Sys-Virt/">perl</a>,
- <a href="python.html">python</a>,
- <a href="php.html">php</a>,
- <a href="https://libvirt.org/ruby/">ruby</a>
- and integration API modules for
- <a href="dbus.html">D-Bus</a></dd>
-
-
- <dt><a href="format.html">XML schemas</a></dt>
- <dd>Description of the XML schemas for
- <a href="formatdomain.html">domains</a>,
- <a href="formatnetwork.html">networks</a>,
- <a href="formatnetworkport.html">network ports</a>,
- <a href="formatnwfilter.html">network filtering</a>,
- <a href="formatstorage.html">storage</a>,
- <a href="formatstorageencryption.html">storage encryption</a>,
- <a href="formatcaps.html">capabilities</a>,
- <a href="formatdomaincaps.html">domain capabilities</a>,
- <a href="formatstoragecaps.html">storage pool capabilities</a>,
- <a href="formatnode.html">node devices</a>,
- <a href="formatsecret.html">secrets</a>,
- <a href="formatsnapshot.html">snapshots</a>,
- <a href="formatcheckpoint.html">checkpoints</a>,
- <a href="formatbackup.html">backup jobs</a></dd>
-
- <dt><a href="uri.html">URI format</a></dt>
- <dd>The URI formats used for connecting to libvirt</dd>
-
- <dt><a href="cgroups.html">CGroups</a></dt>
- <dd>Control groups integration</dd>
-
- <dt><a href="drivers.html">Drivers</a></dt>
- <dd>Hypervisor specific driver information</dd>
-
- <dt><a href="support.html">Support guarantees</a></dt>
- <dd>Details of support status for various interfaces</dd>
-
- <dt><a href="hvsupport.html">Driver support</a></dt>
- <dd>matrix of API support per hypervisor per release</dd>
-
- <dt><a href="kbase/index.html">Knowledge Base</a></dt>
- <dd>Task oriented guides to key features</dd>
- </dl>
- </div>
-
- <div class="panel">
- <h2>Project development</h2>
- <dl>
- <dt><a href="hacking.html">Contributor guidelines</a></dt>
- <dd>General hacking guidelines for contributors</dd>
-
- <dt><a href="styleguide.html">Docs style guide</a></dt>
- <dd>Style guidelines for reStructuredText docs</dd>
-
- <dt><a href="strategy.html">Project strategy</a></dt>
- <dd>Sets a vision for future direction & technical choices</dd>
-
- <dt><a href="ci.html">CI Testing</a></dt>
- <dd>Details of the Continuous Integration testing strategy</dd>
-
- <dt><a href="bugs.html">Bug reports</a></dt>
- <dd>How and where to report bugs and request features</dd>
-
- <dt><a href="compiling.html">Compiling</a></dt>
- <dd>How to compile libvirt</dd>
-
- <dt><a href="goals.html">Goals</a></dt>
- <dd>Terminology and goals of libvirt API</dd>
-
- <dt><a href="api.html">API concepts</a></dt>
- <dd>The libvirt API concepts</dd>
-
- <dt><a href="api_extension.html">API extensions</a></dt>
- <dd>Adding new public libvirt APIs</dd>
-
- <dt><a href="internals/eventloop.html">Event loop and worker pool</a></dt>
- <dd>Libvirt's event loop and worker pool mode</dd>
-
- <dt><a href="internals/command.html">Spawning commands</a></dt>
- <dd>Spawning commands from libvirt driver code</dd>
-
- <dt><a href="internals/rpc.html">RPC protocol & APIs</a></dt>
- <dd>RPC protocol information and API / dispatch guide</dd>
-
- <dt><a href="internals/locking.html">Lock managers</a></dt>
- <dd>Use lock managers to protect disk content</dd>
-
- <dt><a href="testsuites.html">Functional testing</a></dt>
- <dd>Testing libvirt with <a href="testtck.html">TCK test suite</a> and
- <a href="testapi.html">Libvirt-test-API</a></dd>
-
- <dt><a href="newreposetup.html">New repo setup</a></dt>
- <dd>Procedure for configuring new git repositories for libvirt</dd>
- </dl>
- </div>
-
- <br class="clear"/>
-
- </body>
-</html>
diff --git a/docs/docs.rst b/docs/docs.rst
new file mode 100644
index 0000000000..299c26d09b
--- /dev/null
+++ b/docs/docs.rst
@@ -0,0 +1,175 @@
+=============
+Documentation
+=============
+
+Deployment / operation
+----------------------
+
+`Applications <apps.html>`__
+ Applications known to use libvirt
+
+`Manual pages <manpages/index.html>`__
+ Manual pages for libvirt tools / daemons
+
+`Windows <windows.html>`__
+ Downloads for Windows
+
+`macOS <macos.html>`__
+ Working with libvirt on macOS
+
+`Migration <migration.html>`__
+ Migrating guests between machines
+
+`Daemons <daemons.html>`__
+ Overview of the daemons provided by libvirt
+
+`Remote access <remote.html>`__
+ Enable remote access over TCP
+
+`TLS certs <tlscerts.html>`__
+ Generate and deploy x509 certificates for TLS
+
+`Authentication <auth.html>`__
+ Configure authentication for the libvirt daemon
+
+`Access control <acl.html>`__
+ Configure access control libvirt APIs with `polkit <aclpolkit.html>`__
+
+`Logging <logging.html>`__
+ The library and the daemon logging support
+
+`Audit log <auditlog.html>`__
+ Audit trail logs for host operations
+
+`Firewall <firewall.html>`__
+ Firewall and network filter configuration
+
+`Hooks <hooks.html>`__
+ Hooks for system specific management
+
+`NSS module <nss.html>`__
+ Enable domain host name translation to IP addresses
+
+`FAQ <https://wiki.libvirt.org/page/FAQ>`__
+ Frequently asked questions
+
+Application development
+-----------------------
+
+`API reference <html/index.html>`__
+ Reference manual for the C public API, split in
+ `common <html/libvirt-libvirt-common.html>`__,
+ `domain <html/libvirt-libvirt-domain.html>`__,
+ `domain checkpoint <html/libvirt-libvirt-domain-checkpoint.html>`__,
+ `domain snapshot <html/libvirt-libvirt-domain-snapshot.html>`__,
+ `error <html/libvirt-virterror.html>`__,
+ `event <html/libvirt-libvirt-event.html>`__,
+ `host <html/libvirt-libvirt-host.html>`__,
+ `interface <html/libvirt-libvirt-interface.html>`__,
+ `network <html/libvirt-libvirt-network.html>`__,
+ `node device <html/libvirt-libvirt-nodedev.html>`__,
+ `network filter <html/libvirt-libvirt-nwfilter.html>`__,
+ `secret <html/libvirt-libvirt-secret.html>`__,
+ `storage <html/libvirt-libvirt-storage.html>`__,
+ `stream <html/libvirt-libvirt-stream.html>`__ and
+ `admin <html/index-admin.html>`__,
+ `QEMU <html/index-qemu.html>`__,
+ `LXC <html/index-lxc.html>`__ libs
+
+`Language bindings and API modules <bindings.html>`__
+ Bindings of the libvirt API for
+ `c# <csharp.html>`__,
+ `go <https://pkg.go.dev/libvirt.org/go/libvirt>`__,
+ `java <java.html>`__,
+ `ocaml <https://libvirt.org/ocaml/>`__,
+ `perl <https://search.cpan.org/dist/Sys-Virt/>`__,
+ `python <python.html>`__,
+ `php <php.html>`__,
+ `ruby <https://libvirt.org/ruby/>`__
+ and integration API modules for
+ `D-Bus <dbus.html>`__
+
+`XML schemas <format.html>`__
+ Description of the XML schemas for
+ `domains <formatdomain.html>`__,
+ `networks <formatnetwork.html>`__,
+ `network ports <formatnetworkport.html>`__,
+ `network filtering <formatnwfilter.html>`__,
+ `storage <formatstorage.html>`__,
+ `storage encryption <formatstorageencryption.html>`__,
+ `capabilities <formatcaps.html>`__,
+ `domain capabilities <formatdomaincaps.html>`__,
+ `storage pool capabilities <formatstoragecaps.html>`__,
+ `node devices <formatnode.html>`__,
+ `secrets <formatsecret.html>`__,
+ `snapshots <formatsnapshot.html>`__,
+ `checkpoints <formatcheckpoint.html>`__,
+ `backup jobs <formatbackup.html>`__
+
+`URI format <uri.html>`__
+ The URI formats used for connecting to libvirt
+
+`CGroups <cgroups.html>`__
+ Control groups integration
+
+`Drivers <drivers.html>`__
+ Hypervisor specific driver information
+
+`Support guarantees <support.html>`__
+ Details of support status for various interfaces
+
+`Driver support <hvsupport.html>`__
+ matrix of API support per hypervisor per release
+
+`Knowledge Base <kbase/index.html>`__
+ Task oriented guides to key features
+
+Project development
+-------------------
+
+`Contributor guidelines <hacking.html>`__
+ General hacking guidelines for contributors
+
+`Docs style guide <styleguide.html>`__
+ Style guidelines for reStructuredText docs
+
+`Project strategy <strategy.html>`__
+ Sets a vision for future direction & technical choices
+
+`CI Testing <ci.html>`__
+ Details of the Continuous Integration testing strategy
+
+`Bug reports <bugs.html>`__
+ How and where to report bugs and request features
+
+`Compiling <compiling.html>`__
+ How to compile libvirt
+
+`Goals <goals.html>`__
+ Terminology and goals of libvirt API
+
+`API concepts <api.html>`__
+ The libvirt API concepts
+
+`API extensions <api_extension.html>`__
+ Adding new public libvirt APIs
+
+`Event loop and worker pool <internals/eventloop.html>`__
+ Libvirt's event loop and worker pool mode
+
+`Spawning commands <internals/command.html>`__
+ Spawning commands from libvirt driver code
+
+`RPC protocol & APIs <internals/rpc.html>`__
+ RPC protocol information and API / dispatch guide
+
+`Lock managers <internals/locking.html>`__
+ Use lock managers to protect disk content
+
+`Functional testing <testsuites.html>`__
+ Testing libvirt with
+ `TCK test suite <testtck.html>`__ and
+ `Libvirt-test-API <testapi.html>`__
+
+`New repo setup <newreposetup.html>`__
+ Procedure for configuring new git repositories for libvirt
diff --git a/docs/meson.build b/docs/meson.build
index 75b5e4c08f..9e69a0dc05 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -18,7 +18,6 @@ docs_assets = [
]
docs_html_in_files = [
- 'docs',
'formatcaps',
'formatdomaincaps',
'formatnetwork',
@@ -53,6 +52,7 @@ docs_rst_files = [
'csharp',
'daemons',
'dbus',
+ 'docs',
'downloads',
'drivers',
'drvbhyve',
--
2.35.1
More information about the libvir-list
mailing list