]> git.ipfire.org Git - thirdparty/libvirt.git/commit
docs: html.in: Convert api to rst
authorErik Skultety <eskultet@redhat.com>
Fri, 12 Mar 2021 10:53:13 +0000 (11:53 +0100)
committerErik Skultety <eskultet@redhat.com>
Mon, 15 Mar 2021 16:31:35 +0000 (17:31 +0100)
commit39a80474f6b4c69da9ee64cba32955c500b00356
tree365414e688aa5d5b584ad88c8069a9c3673f8568
parent9d503ea9dc2fa0b9a5a3c8f10757a264eaf0fbd2
docs: html.in: Convert api to rst

There were a number of occurrences where we used nested inline markup
(verbatim + refs) which is currently not possible with RST syntax [1].
There is a possible workaround involving substitution definitions like

  .. |virConnectPtr| replace:: ``virConnectPtr``
  .. _virConnectPtr: /html/libvirt-libvirt-host.html#virConnectPtr

Substitutions cannot be made generic, hence we cannot create a template
for substitution and use a single template everywhere, so we'd end up
with a lot of clutter and convolution. Therefore, we can make an
exception and just link the data type without further style markup.

[1] https://docutils.sourceforge.io/FAQ.html#is-nested-inline-markup-possible

Signed-off-by: Erik Skultety <eskultet@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
docs/api.html.in [deleted file]
docs/api.rst [new file with mode: 0644]
docs/meson.build