[PATCH 3/8] docs: Convert 'testapi' page to rST
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
docs/meson.build | 2 +-
docs/testapi.html.in | 35 -----------------------------------
docs/testapi.rst | 34 ++++++++++++++++++++++++++++++++++
3 files changed, 35 insertions(+), 36 deletions(-)
delete mode 100644 docs/testapi.html.in
create mode 100644 docs/testapi.rst
diff --git a/docs/meson.build b/docs/meson.build
index aaafa7d8e1..087afb15d9 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -57,7 +57,6 @@ docs_html_in_files = [
'python',
'remote',
'storage',
- 'testapi',
'testsuites',
'testtck',
'tlscerts',
@@ -112,6 +111,7 @@ docs_rst_files = [
'styleguide',
'submitting-patches',
'support',
+ 'testapi',
]
# list of web targets to build for docs/web rule
diff --git a/docs/testapi.html.in b/docs/testapi.html.in
deleted file mode 100644
index e7cd9453ee..0000000000
--- a/docs/testapi.html.in
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
- <body>
- <h1>libvirt-test-API: Python based test suite </h1>
- <p>Libvirt-test-API is a powerful test tool designed to complement
- existing libvirt test tools such as libvirt-TCK and the internal
- test suite. It aims at functional regression testing, trying to
- exercise nearly all the API by the way of the Python bindings.</p>
- <p>The test API currently covers:</p>
- <ul>
- <li>domain: all classical lifetime operations, installation of
- various guests OSes, snapshots</li>
- <li>interfaces: define, create, destroy, undefine, NPIV</li>
- <li>virtual networks: define, create, destroy, undefine</li>
- <li>storage: regression tests for most storage types and configurations
- dir, disk, netfs, iSCSI, multipath</li>
- </ul>
- <p>Some of the tests need dedicated local resources whose definitions
- are stored in a configuration file. The tests are defined using
- Python modules defining the code for the test, this is called
- a <tt>test case</tt>, and test <tt>configuration
files</tt> using one
- or more test case to define a given test scenario.</p>
- <p>For more details you can look at:</p>
- <ul>
- <li> A <a
href="https://libvirt.org/sources/libvirt-test-API/Libvirt-test-API....
PDF</a>
- file describing the test suite and how to write test cases
- and test scenarios.</li>
- </ul>
- <p> Libvirt-test-API is maintained using
- <a href="https://gitlab.com/libvirt/libvirt-test-API">a GIT
- repository</a>, and comment, patches and reviews are carried
- on the <a href="contact.html">libvir-list</a> development
list.</p>
- </body>
-</html>
diff --git a/docs/testapi.rst b/docs/testapi.rst
new file mode 100644
index 0000000000..9aa0afb761
--- /dev/null
+++ b/docs/testapi.rst
@@ -0,0 +1,34 @@
+=========================================
+libvirt-test-API: Python based test suite
+=========================================
+
+Libvirt-test-API is a powerful test tool designed to complement existing libvirt
+test tools such as libvirt-TCK and the internal test suite. It aims at
+functional regression testing, trying to exercise nearly all the API by the way
+of the Python bindings.
+
+The test API currently covers:
+
+- domain: all classical lifetime operations, installation of various guests
+ OSes, snapshots
+- interfaces: define, create, destroy, undefine, NPIV
+- virtual networks: define, create, destroy, undefine
+- storage: regression tests for most storage types and configurations dir,
+ disk, netfs, iSCSI, multipath
+
+Some of the tests need dedicated local resources whose definitions are stored in
+a configuration file. The tests are defined using Python modules defining the
+code for the test, this is called a test case, and test configuration files
+using one or more test case to define a given test scenario.
+
+For more details you can look at:
+
+- A `documentation
+ PDF <https://libvirt.org/sources/libvirt-test-API/Libvirt-test-API.pdf>`__
+ file describing the test suite and how to write test cases and test
+ scenarios.
+
+Libvirt-test-API is maintained using `a GIT
+repository <https://gitlab.com/libvirt/libvirt-test-API>`__, and comment,
+patches and reviews are carried on the `libvir-list <contact.html>`__
+development list.
--
2.35.1