Signed-off-by: Erik Skultety <eskultet@xxxxxxxxxx> --- docs/bindings.html.in | 101 ------------------------------------------ docs/bindings.rst | 62 ++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 63 insertions(+), 102 deletions(-) delete mode 100644 docs/bindings.html.in create mode 100644 docs/bindings.rst diff --git a/docs/bindings.html.in b/docs/bindings.html.in deleted file mode 100644 index a1520707c5..0000000000 --- a/docs/bindings.html.in +++ /dev/null @@ -1,101 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE html> -<html xmlns="http://www.w3.org/1999/xhtml"> - <body> - <h1 >Bindings for other languages and integration API modules</h1> - - <p> - Libvirt supports C and C++ directly, and has bindings available - for other languages: - </p> - - <ul> - <li> - <strong>C#</strong>: Arnaud Champion develops - <a href="csharp.html">C# bindings</a>. - </li> - <li> - <strong>Go</strong>: Daniel Berrange develops - <a href="https://pkg.go.dev/libvirt.org/libvirt-go">Go bindings</a>. - </li> - <li> - <strong>Java</strong>: Daniel Veillard develops - <a href="java.html">Java bindings</a>. - </li> - <li> - <strong>OCaml</strong>: Richard Jones develops - <a href="https://libvirt.org/ocaml/">OCaml bindings</a>. - </li> - <li> - <strong>Perl</strong>: Daniel Berrange develops - <a href="https://search.cpan.org/dist/Sys-Virt/">Perl bindings</a>. - </li> - <li> - <p> - <strong>PHP</strong>: Radek Hladik started developing - <a href="https://libvirt.org/php">PHP bindings</a> in 2010. - </p> - <p> - In February 2011 the binding development has been moved to the libvirt.org website as - libvirt-php project. - </p> - <p> - The project is now maintained by Michal Novotny and it's heavily based - on Radek's version. For more information, including - information on posting patches to libvirt-php, please refer - to the <a href="https://libvirt.org/php">PHP bindings</a> site. - </p> - </li> - <li> - <p> - <strong>Python</strong>: Libvirt's python bindings are split to a - separate <a href="https://gitlab.com/libvirt/libvirt-python">package</a> - since version 1.2.0, older versions came with direct support for the - Python language. - </p> - <p> - If your libvirt is installed as packages, rather than compiled - by you from source code, ensure you have the appropriate - package installed. - </p> - <p> - This is named <b>libvirt-python</b> on RHEL/Fedora, - <a href="https://packages.ubuntu.com/search?keywords=python-libvirt"><b>python-libvirt</b></a> - on Ubuntu, and may be named differently on others. - </p> - <p> - For usage information, see the - <a href="python.html">Python API bindings</a> page. - </p> - </li> - <li> - <strong>Ruby</strong>: Chris Lalancette develops - <a href="https://libvirt.org/ruby/">Ruby bindings</a>. - </li> - </ul> - - <p> - Integration API modules: - </p> - - <ul> - <li> - <strong>D-Bus</strong>: Pavel Hrdina develops - <a href="dbus.html">D-Bus API</a>. - </li> - </ul> - - <p> - For information on using libvirt on <strong>Windows</strong> - <a href="windows.html">please see the Windows support page</a>. - </p> - - <p> - Support, requests or help for libvirt bindings are welcome on the - <a href="https://www.redhat.com/mailman/listinfo/libvir-list/">mailing list</a>, - as usual try to provide enough background information and make sure - you use recent version, see the <a href="bugs.html">help page</a>. - </p> - - </body> -</html> diff --git a/docs/bindings.rst b/docs/bindings.rst new file mode 100644 index 0000000000..c5b6b94519 --- /dev/null +++ b/docs/bindings.rst @@ -0,0 +1,62 @@ +======================================================== +Bindings for other languages and integration API modules +======================================================== + +.. contents:: + +Libvirt supports C and C++ directly, and has bindings available for +other languages: + +- **C#**: Arnaud Champion develops `C# bindings <csharp.html>`__. + +- **Go**: Daniel Berrange develops `Go + bindings <https://pkg.go.dev/libvirt.org/libvirt-go>`__. + +- **Java**: Daniel Veillard develops `Java bindings <java.html>`__. + +- **OCaml**: Richard Jones develops `OCaml + bindings <https://libvirt.org/ocaml/>`__. + +- **Perl**: Daniel Berrange develops `Perl + bindings <https://search.cpan.org/dist/Sys-Virt/>`__. + +- **PHP**: Radek Hladik started developing `PHP + bindings <https://libvirt.org/php>`__ in 2010. + + In February 2011 the binding development has been moved to the + libvirt.org website as libvirt-php project. + + The project is now maintained by Michal Novotny and it's heavily + based on Radek's version. For more information, including information + on posting patches to libvirt-php, please refer to the `PHP + bindings <https://libvirt.org/php>`__ site. + +- **Python**: Libvirt's python bindings are split to a separate + `package <https://gitlab.com/libvirt/libvirt-python>`__ since version + 1.2.0, older versions came with direct support for the Python + language. + + If your libvirt is installed as packages, rather than compiled by you + from source code, ensure you have the appropriate package installed. + + This is named **libvirt-python** on RHEL/Fedora, + `python-libvirt <https://packages.ubuntu.com/search?keywords=python-libvirt>`__ + on Ubuntu, and may be named differently on others. + + For usage information, see the `Python API bindings <python.html>`__ + page. + +- **Ruby**: Chris Lalancette develops `Ruby + bindings <https://libvirt.org/ruby/>`__. + +Integration API modules: + +- **D-Bus**: Pavel Hrdina develops `D-Bus API <dbus.html>`__. + +For information on using libvirt on **Windows** `please see the Windows +support page <windows.html>`__. + +Support, requests or help for libvirt bindings are welcome on the +`mailing list <https://www.redhat.com/mailman/listinfo/libvir-list/>`__, +as usual try to provide enough background information and make sure you +use recent version, see the `help page <bugs.html>`__. diff --git a/docs/meson.build b/docs/meson.build index 0179a68908..f4b29a2e59 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -32,7 +32,6 @@ docs_assets = [ docs_html_in_files = [ '404', - 'bindings', 'bugs', 'cgroups', 'compiling', @@ -107,6 +106,7 @@ docs_rst_files = [ 'architecture', 'auditlog', 'auth', + 'bindings', 'best-practices', 'ci', 'coding-style', -- 2.29.2