🔗 Use READTHEDOCS_CANONICAL_URL as baseurl if defined

[LecrisUT]

There must be a better way around this with relative paths ¹, but until then, this is a simple quick-fix for RTD deployments. The user would still need #984 to have a seamless experience.

Closes #983

Footnotes

1. https://github.com/executablebooks/mystmd/issues/188#issuecomment-2003171341 ↩

[rowanc1]

Looks great - happy to get this in fast! I left a question about the canonical url, and changing that to a pathname (and maybe testing it and raising helpful feedback).

[rowanc1]

It looks like this is the full URL, and not just a part of it? (based on docs here).

I think that we should validate and only be taking the path part of the URL. in this case something like /en/latest. Perhaps something like:

Suggested change

	} else if ((baseurl = process.env.READTHEDOCS_CANONICAL_URL)) {
	session.log.info('Building inside a ReadTheDocs environment');
	} else if (process.env.READTHEDOCS_CANONICAL_URL) {
	baseurl = new URL(process.env.READTHEDOCS_CANONICAL_URL).pathname.replace(/\/$/, '');
	session.log.info(`Building inside a ReadTheDocs environment with BASE_URL="${baseurl}"`);

The base URL is absolute and should not end with a trailing slash.

Now that there is a function, we could test the URL against that even a simple regexp like this: /^\/(.*)([^\/])$/ and raising an error if it doesn't match.

[LecrisUT]

Kay, I've added the sanitization, with a bit different info reporting.

I was looking at adding a unit test, but I couldn't find a framework to use, and I'm not sure of how/where vitest are defined

[choldgraf]

Is this one ready to go? Is it related to the other RTD PR?

• 📖 Add ReadTheDocs automation #982

[LecrisUT]

Is this one ready to go?

Yes, there were suggestions for adding unit test, but I couldn't figure out how to add them. Otherwise implementation wise it should be finished.

Is it related to the other RTD PR?

They are independent, but it would help simplify 1 line there. The RTD PR is a bit problematic due to the hydration and missing .html extension issues

[rowanc1]

I can take another look later today, sorry for dropping the ball on getting these in!

[rowanc1]

Added a changeset, merging when tests pass!