Canonical ref does not match URL for builds that use dirhtml builder

[benjaoming]

Details

Upstream issue: sphinx-doc/sphinx#9730

• Read the Docs project URL: https://packaging.python.org/en/latest/tutorials/packaging-projects/
• Build URL (if applicable): https://readthedocs.org/projects/{your_project_slug}/builds/{build_id}/
• Config: https://github.com/pypa/packaging.python.org/blob/main/.readthedocs.yaml

Expected Result

<link rel="canonical" href="[https://packaging.python.org/en/latest/tutorials/packaging-projects.html" />

Actual Result

<link rel="canonical" href="[https://packaging.python.org/en/latest/tutorials/packaging-projects/" />

[benjaoming]

All this might be a Sphinx issue though. I haven't had the time to check.

[stsewd]

I think this was a problem when installing an outdated version of sphinx, and then installing a new one over it. They have their requirements set explicitly https://github.com/pypa/packaging.python.org/blob/main/requirements.txt, so we should be fine enabling the install latest feature flag.

[benjaoming]

I think this was a problem when installing an outdated version of sphinx, and then installing a new one over it.

So the issue originates from this behavior?

https://github.com/readthedocs/readthedocs.org/blob/fc7f68b9848e4c6a39014801829d395df2aede86/readthedocs/doc_builder/python_environments.py#L203-L222

How does sphinx==4.5.0 end up having its build outputs affected by the previous Sphinx installation?

[benjaoming]

Seems that the theme, python-docs-theme, is the reason for being stuck with sphinx 4.x until the work by Adam is merged - https://github.com/python/python-docs-theme/pull/99

[stsewd]

o we should be fine enabling the install latest feature flag.

And... that didn't work :D

[benjaoming]

Similar issue here: https://test-builds.readthedocs.io/en/htmldir/folder/

[benjaoming]

I upgraded Sphinx to the latest version in https://test-builds.readthedocs.io/en/htmldir/ but the issue persists.

[ericholscher]

Yea, this is a bug, we should prioritize fixing it. It's likely causing lots of search issues.

[benjaoming]

@ericholscher I just saw that the issue description here has broken down where the bug might be found: #1303

[benjaoming]

This is indeed an issue in the theme. .html is hard-coded regardless of the builder.

https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/layout.html#L54

Moving this issue and opening a PR since I'm already in the area 👍