[libvirt PATCH 3/9] docs: html.in: Convert api to rst

Peter Krempa pkrempa at redhat.com
Mon Mar 15 10:32:15 UTC 2021


On Fri, Mar 12, 2021 at 12:43:06 +0100, Erik Skultety wrote:
> 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 at redhat.com>
> ---
>  docs/api.html.in | 380 -----------------------------------------------
>  docs/api.rst     | 265 +++++++++++++++++++++++++++++++++
>  docs/meson.build |   2 +-
>  3 files changed, 266 insertions(+), 381 deletions(-)
>  delete mode 100644 docs/api.html.in
>  create mode 100644 docs/api.rst

Reviewed-by: Peter Krempa <pkrempa at redhat.com>




More information about the libvir-list mailing list