diff mbox series

[2/3] docs: avoid unreferenced footnote

Message ID 20241011094948.34550-3-pbonzini@redhat.com (mailing list archive)
State New, archived
Headers show
Series docs: fix and cleanup footnotes | expand

Commit Message

Paolo Bonzini Oct. 11, 2024, 9:49 a.m. UTC
The link to fosdem.org is inlined but also included in the footnote [#c].
Replace the inline link with a reference to the footnote, because Sphinx
8.1.0 is a lot stricter about unreferenced footnotes.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/devel/testing/acpi-bits.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Peter Maydell Oct. 11, 2024, 10:39 a.m. UTC | #1
On Fri, 11 Oct 2024 at 10:50, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> The link to fosdem.org is inlined but also included in the footnote [#c].
> Replace the inline link with a reference to the footnote, because Sphinx
> 8.1.0 is a lot stricter about unreferenced footnotes.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  docs/devel/testing/acpi-bits.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/docs/devel/testing/acpi-bits.rst b/docs/devel/testing/acpi-bits.rst
> index 78aeb6aa3c4..2e4f1d23def 100644
> --- a/docs/devel/testing/acpi-bits.rst
> +++ b/docs/devel/testing/acpi-bits.rst
> @@ -37,8 +37,8 @@ dependent submodules `here <https://gitlab.com/qemu-project/biosbits-bits>`__.
>  This fork contains numerous fixes, a newer acpica and changes specific to
>  running these functional QEMU tests using bits. The author of this document
>  is the sole maintainer of the QEMU fork of bios bits repository. For more
> -information, please see author's `FOSDEM talk on this bios-bits based test
> -framework <https://fosdem.org/2024/schedule/event/fosdem-2024-2262-exercising-qemu-generated-acpi-smbios-tables-using-biosbits-from-within-a-guest-vm-/>`__.
> +information, please see author's FOSDEM talk on this bios-bits based test
> +framework\ [#c]_.
>
>  *********************************
>  Description of the test framework

I think for this doc, because all the footnotes are
simply URLs it will produce a better HTML document if
we instead convert them all to hyperlinks in line.
At the moment you have to click on the footnote link
and then again on the URL.

thanks
-- PMM
diff mbox series

Patch

diff --git a/docs/devel/testing/acpi-bits.rst b/docs/devel/testing/acpi-bits.rst
index 78aeb6aa3c4..2e4f1d23def 100644
--- a/docs/devel/testing/acpi-bits.rst
+++ b/docs/devel/testing/acpi-bits.rst
@@ -37,8 +37,8 @@  dependent submodules `here <https://gitlab.com/qemu-project/biosbits-bits>`__.
 This fork contains numerous fixes, a newer acpica and changes specific to
 running these functional QEMU tests using bits. The author of this document
 is the sole maintainer of the QEMU fork of bios bits repository. For more
-information, please see author's `FOSDEM talk on this bios-bits based test
-framework <https://fosdem.org/2024/schedule/event/fosdem-2024-2262-exercising-qemu-generated-acpi-smbios-tables-using-biosbits-from-within-a-guest-vm-/>`__.
+information, please see author's FOSDEM talk on this bios-bits based test
+framework\ [#c]_.
 
 *********************************
 Description of the test framework