diff mbox series

yp-intro: new doc reference is missing leading slash

Message ID b08ac36e-51de-71b6-53ad-a2f05b0d31ae@crashcourse.ca
State Under Review
Headers show
Series yp-intro: new doc reference is missing leading slash | expand

Commit Message

Robert P. J. Day June 18, 2025, 7:47 a.m. UTC
The new ":doc:" reference for yocto-project-supported-features appears
to be missing a leading slash, causing HTML generation to fail.

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

Comments

Robert P. J. Day June 18, 2025, 7:54 a.m. UTC | #1
On Wed, 18 Jun 2025, Robert P. J. Day wrote:

>
> The new ":doc:" reference for yocto-project-supported-features appears
> to be missing a leading slash, causing HTML generation to fail.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
> index 15dfb3a6b..40e9693a8 100644
> --- a/documentation/overview-manual/yp-intro.rst
> +++ b/documentation/overview-manual/yp-intro.rst
> @@ -51,7 +51,7 @@ Here are features and advantages of the Yocto Project:
>     RISC-V and other architectures. Most ODMs, OSVs, and chip vendors create and
>     supply BSPs that support their hardware. If you have custom silicon, you can
>     create a BSP that supports that architecture. See
> -   :doc:`ref-manual/yocto-project-supported-features` for details on the level
> +   :doc:`/ref-manual/yocto-project-supported-features` for details on the level
>     of support for some of these architectures.
>
>     Aside from broad architecture support, the Yocto Project fully
>
  *Sigh* ... never mind, should have checked master-next.

rday
Antonin Godard June 18, 2025, 11:01 a.m. UTC | #2
On Wed Jun 18, 2025 at 9:54 AM CEST, Robert P. J. Day wrote:
> On Wed, 18 Jun 2025, Robert P. J. Day wrote:
>
>>
>> The new ":doc:" reference for yocto-project-supported-features appears
>> to be missing a leading slash, causing HTML generation to fail.
>>
>> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>>
>> ---
>>
>> diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
>> index 15dfb3a6b..40e9693a8 100644
>> --- a/documentation/overview-manual/yp-intro.rst
>> +++ b/documentation/overview-manual/yp-intro.rst
>> @@ -51,7 +51,7 @@ Here are features and advantages of the Yocto Project:
>>     RISC-V and other architectures. Most ODMs, OSVs, and chip vendors create and
>>     supply BSPs that support their hardware. If you have custom silicon, you can
>>     create a BSP that supports that architecture. See
>> -   :doc:`ref-manual/yocto-project-supported-features` for details on the level
>> +   :doc:`/ref-manual/yocto-project-supported-features` for details on the level
>>     of support for some of these architectures.
>>
>>     Aside from broad architecture support, the Yocto Project fully
>>
>   *Sigh* ... never mind, should have checked master-next.

No, you're right, this was indeed broken on master.

Thanks for the fix,
Antonin
diff mbox series

Patch

diff --git a/documentation/overview-manual/yp-intro.rst b/documentation/overview-manual/yp-intro.rst
index 15dfb3a6b..40e9693a8 100644
--- a/documentation/overview-manual/yp-intro.rst
+++ b/documentation/overview-manual/yp-intro.rst
@@ -51,7 +51,7 @@  Here are features and advantages of the Yocto Project:
    RISC-V and other architectures. Most ODMs, OSVs, and chip vendors create and
    supply BSPs that support their hardware. If you have custom silicon, you can
    create a BSP that supports that architecture. See
-   :doc:`ref-manual/yocto-project-supported-features` for details on the level
+   :doc:`/ref-manual/yocto-project-supported-features` for details on the level
    of support for some of these architectures.

    Aside from broad architecture support, the Yocto Project fully