Links within 'Mega' Manual?

Links within 'Mega' Manual?

[Daniel Ammann]

Hello

It looks like links within the 'Mega' Manual do not work.
E.g.
- Go to https://docs.yoctoproject.org/
- Switch to the 'Mega' Manual.
- Click on one of the links to within the document (e.g. "Build Host").
- The link is now https://docs.yoctoproject.org/singleindex.html#document-ref-manual/terms#term-Build-Host
   and doesn't work.

I tested with firefox and chromium.

Kind regards

Daniel

Re: [docs] Links within 'Mega' Manual?

[Antonin Godard]

Hi,

On Tue Feb 17, 2026 at 8:59 AM CET, Daniel Ammann wrote:
> Hello
>
> It looks like links within the 'Mega' Manual do not work.
> E.g.
> - Go to https://docs.yoctoproject.org/
> - Switch to the 'Mega' Manual.
> - Click on one of the links to within the document (e.g. "Build Host").
> - The link is now https://docs.yoctoproject.org/singleindex.html#document-ref-manual/terms#term-Build-Host
>    and doesn't work.

You're right, thanks for the report. I'll look into it.

Antonin

Re: [docs] Links within 'Mega' Manual?

[Antonin Godard]

On Tue Feb 17, 2026 at 8:59 AM CET, Daniel Ammann wrote:
> Hello
>
> It looks like links within the 'Mega' Manual do not work.
> E.g.
> - Go to https://docs.yoctoproject.org/
> - Switch to the 'Mega' Manual.
> - Click on one of the links to within the document (e.g. "Build Host").
> - The link is now https://docs.yoctoproject.org/singleindex.html#document-ref-manual/terms#term-Build-Host
>    and doesn't work.
>
> I tested with firefox and chromium.

I have found that the issue was also reported upstream, and have sent a patch to
our Sphinx recipe that is used to build the documentation on https://docs.yoctoproject.org:

https://lore.kernel.org/r/20260217-fix-sphinx-singlehtml-uris-v1-1-763a999c54db@bootlin.com

If you are building the documentation yourself, make sure to revert the commit
as I did in my link above for now. Hopefully this will be fixed in the next
version of Sphinx.

Thanks again for the report!
Antonin

Re: [docs] Links within 'Mega' Manual?

[Quentin Schulz]

Hi Antonin,

On 2/17/26 11:02 AM, Antonin Godard via lists.yoctoproject.org wrote:
> On Tue Feb 17, 2026 at 8:59 AM CET, Daniel Ammann wrote:
>> Hello
>>
>> It looks like links within the 'Mega' Manual do not work.
>> E.g.
>> - Go to https://docs.yoctoproject.org/
>> - Switch to the 'Mega' Manual.
>> - Click on one of the links to within the document (e.g. "Build Host").
>> - The link is now https://docs.yoctoproject.org/singleindex.html#document-ref-manual/terms#term-Build-Host
>>     and doesn't work.
>>
>> I tested with firefox and chromium.
> 
> I have found that the issue was also reported upstream, and have sent a patch to
> our Sphinx recipe that is used to build the documentation on https://docs.yoctoproject.org/:
> 
> https://lore.kernel.org/r/20260217-fix-sphinx-singlehtml-uris-v1-1-763a999c54db@bootlin.com
> 
> If you are building the documentation yourself, make sure to revert the commit

Maybe rather suggest to use a version which isn't impacted? This is much 
easier than reverting a patch? According to 
https://github.com/sphinx-doc/sphinx/commit/c93723b80396959e19442f7058ad3412eaf11468 
the commit is in version v8.2.0 and later. So anything below that 
version should be fine.

I'm wondering if we should enforce that in Pipfile and pip3_docs.sh 
maybe? We'll have an issue once a new release is published with this 
fixed where we'll want Sphinx to not come from a specific range. At that 
point, I guess we can refuse to build singlehtml from the Makefile 
directly if sphinx-build is in that unsupported range.

What do you think?

Cheers,
Quentin