Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SQL-99 RTD URL errors #462

Closed
msbt opened this issue Feb 22, 2024 · 2 comments
Closed

SQL-99 RTD URL errors #462

msbt opened this issue Feb 22, 2024 · 2 comments
Assignees

Comments

@msbt
Copy link
Collaborator

msbt commented Feb 22, 2024

Super low priority, because this affects only assets from readthedocs, but I prefer to not have errors in the browser console ;) Since we changed the URL to be external, we also need to update html_baseurl, canonical_url_path and url_path of the project

https://github.com/crate/crate-docs-theme/blob/main/src/crate/theme/rtd/conf/sql_99.py#L31-L41 for reference. Do you reckon it's enough if we set the following:

from
url_path = "docs/sql-99"to
url_path = ""

from
html_baseurl = "https://cratedb.com/%s/" % url_path to
html_baseurl = "https://sql-99.readthedocs.io" % url_path or even omit the % url_path altogether for this and the next?

from
"canonical_url_path": "%s/en/latest/" % url_path, to
"canonical_url_path": "/en/latest/" % url_path,

If you could confirm that this is how it's supposed to be, I'm happy to create a PR.

@amotl
Copy link
Member

amotl commented Feb 22, 2024

Hi Matthias. Your proposal looks good, but I can't tell if it will work. The intertwingulation on this level is of such a shape that I am exclusively approaching corresponding changes on a trial-and-error basis.

Feel free to create a PR to just probe if it works. When it doesn't, we'll improve or revert.

@msbt
Copy link
Collaborator Author

msbt commented Feb 22, 2024

Hah good point, #464 for reference

@msbt msbt closed this as completed Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants