Skip to content
  • David Woodhouse's avatar
    doc/sphinx/hxtool.py: add optional label argument to SRST directive · 1eeb432a
    David Woodhouse authored and Peter Maydell's avatar Peter Maydell committed
    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 optional argument to the SRST directive which causes a label
    of the form '.. _DOCNAME-HXFILE-LABEL:' to be emitted, where 'DOCNAME'
    is the name of the top level rST file, 'HXFILE' is the filename of the
    .hx file, and 'LABEL' is the text provided within the 'SRST()' directive.
    Using the DOCNAME of the top-level rST document means that it is unique
    even when the .hx file is included from two different documents, as is
    the case for qemu-options.hx
    
    Now where the Xen PV documentation refers to the documentation for the
    -initrd command line option, it can emit a link directly to it as
    '<system/invocation-qemu-options-initrd>'.
    
    Signed-off-by: default avatarDavid Woodhouse <dwmw@amazon.co.uk>
    Reviewed-by: default avatarPaul Durrant <paul@xen.org>
    Re...
    1eeb432a