[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v4 16/17] doc/sphinx/hxtool.py: add optional label argument to SRST directive



On 06/11/2023 14:35, David Woodhouse wrote:
From: David Woodhouse <dwmw@xxxxxxxxxxxx>

We can't just embed labels directly into files like qemu-options.hx which
are included from multiple top-level RST files, because Sphinx sees the
labels as duplicate: https://github.com/sphinx-doc/sphinx/issues/9707

So add an 'emitrefs' option to the Sphinx hxtool-doc directive, which is
set only in invocation.rst and not from the HTML rendition of the man
page. Along with an argument to the SRST directive which causes a label
of the form '.. _LABEL-reference-label:' to be emitted when the emitrefs
option is set.

Signed-off-by: David Woodhouse <dwmw@xxxxxxxxxxxx>
---
  docs/sphinx/hxtool.py      | 18 +++++++++++++++++-
  docs/system/invocation.rst |  1 +
  2 files changed, 18 insertions(+), 1 deletion(-)


Reviewed-by: Paul Durrant <paul@xxxxxxx>




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.