docs: Add sub-page for all golang modules

Our documentation has pages for 4 go modules, 2 current and 2 obsolete
ones, but points only to one of them and directly to golang's docs page.

Add a sub-page where all 4 sub-pages for the modules are linked.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Peter Krempa 2023-02-14 13:51:02 +01:00
parent f3e44016fa
commit 5f3a897b93
3 changed files with 23 additions and 1 deletions

View File

@ -79,7 +79,7 @@ Application development
`Language bindings and API modules <bindings.html>`__ `Language bindings and API modules <bindings.html>`__
Bindings of the libvirt API for Bindings of the libvirt API for
`c# <csharp.html>`__, `c# <csharp.html>`__,
`go <https://pkg.go.dev/libvirt.org/go/libvirt>`__, `go <https://pkg.go.dev/libvirt.org/go/libvirt>`__ (`all go modules <golang.html>`__),
`java <java.html>`__, `java <java.html>`__,
`ocaml <https://libvirt.org/ocaml/>`__, `ocaml <https://libvirt.org/ocaml/>`__,
`perl <https://search.cpan.org/dist/Sys-Virt/>`__, `perl <https://search.cpan.org/dist/Sys-Virt/>`__,

21
docs/golang.rst Normal file
View File

@ -0,0 +1,21 @@
====================
Go Language bindings
====================
Modern libvirt API bindings with Go modules
-------------------------------------------
The libvirt API bindings package and module for XML manipulation:
- `libvirt.org/go/libvirt <go/libvirt.html>`__ package https://pkg.go.dev/libvirt.org/go/libvirt
- `libvirt.org/go/libvirtxml <go/libvirtxml.html>`__ package https://pkg.go.dev/libvirt.org/go/libvirtxml
Obsolete libvirt language bindings
----------------------------------
The following two go packages were superseded, but software currently using them
will keep working. No further development will take place.
- `libvirt.org/libvirt-go <libvirt-go.html>`__ - CGo binding to the native API
- `libvirt.org/libvirt-go-xml <libvirt-go-xml.html>`)) - annotated Go struct definitions for XML handling

View File

@ -80,6 +80,7 @@ docs_rst_files = [
'formatstorageencryption', 'formatstorageencryption',
'glib-adoption', 'glib-adoption',
'goals', 'goals',
'golang',
'governance', 'governance',
'hacking', 'hacking',
'hooks', 'hooks',