[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 t
From: |
David Woodhouse |
Subject: |
Re: [PATCH v4 16/17] doc/sphinx/hxtool.py: add optional label argument to SRST directive |
Date: |
Tue, 07 Nov 2023 09:25:07 +0000 |
User-agent: |
Evolution 3.44.4-0ubuntu2 |
On Mon, 2023-11-06 at 14:35 +0000, David Woodhouse wrote:
> From: David Woodhouse <dwmw@amazon.co.uk>
>
> 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@amazon.co.uk>
> ---
FWIW I've left this out of the pull request I just sent, and the Xen
docs just tell the user to go *find* the -initrd documentation instead
of being able to emit a direct link. We can fix that later.
smime.p7s
Description: S/MIME cryptographic signature
- [PATCH v4 10/17] hw/xen: add support for Xen primary console in emulated mode, (continued)
- [PATCH v4 10/17] hw/xen: add support for Xen primary console in emulated mode, David Woodhouse, 2023/11/06
- [PATCH v4 17/17] docs: update Xen-on-KVM documentation, David Woodhouse, 2023/11/06
- [PATCH v4 14/17] net: do not delete nics in net_cleanup(), David Woodhouse, 2023/11/06
- [PATCH v4 13/17] hw/i386/pc: support '-nic' for xen-net-device, David Woodhouse, 2023/11/06
- [PATCH v4 11/17] hw/xen: only remove peers of PCI NICs on unplug, David Woodhouse, 2023/11/06
- [PATCH v4 16/17] doc/sphinx/hxtool.py: add optional label argument to SRST directive, David Woodhouse, 2023/11/06