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

Sphinx: use html_baseurl for setting the canonical URL #7540

Merged
merged 2 commits into from Jan 5, 2021

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Oct 6, 2020

stsewd added a commit to readthedocs/readthedocs-sphinx-ext that referenced this pull request Oct 6, 2020
Fix #82

Ref #83

We need to release the extension first, make sure all builds are using
that version and then release readthedocs/readthedocs.org#7540
@stsewd
Copy link
Member Author

stsewd commented Oct 6, 2020

We need to merge and release readthedocs/readthedocs-sphinx-ext#83 first

@stsewd stsewd requested a review from a team October 6, 2020 17:21
@stsewd stsewd added the Status: blocked Issue is blocked on another issue label Oct 6, 2020
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good -- we should probably deprecate the canonical setting at some point, if we have a good way for users to set it.

stsewd added a commit to readthedocs/readthedocs-sphinx-ext that referenced this pull request Oct 6, 2020
Fix #82

Ref #83

We need to release the extension first, make sure all builds are using
that version and then release readthedocs/readthedocs.org#7540
@stsewd
Copy link
Member Author

stsewd commented Oct 6, 2020

We need to remove this flag before merging this, so all users have the latest version of our extension

Feature.USE_SPHINX_RTD_EXT_LATEST,

I'll check how many projects we have with that flag

.. _html_baseurl: https://www.sphinx-doc.org/page/usage/configuration.html#confval-html_baseurl

If you are using :doc:`MkDocs </intro/getting-started-with-mkdocs>`,
you can use the site_url_ setting.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we not automatically support this at all for mkdocs?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, but we can do it if we want #4820 :)

@stsewd
Copy link
Member Author

stsewd commented Oct 7, 2020

This is also blocked on

readthedocs/sphinx_rtd_theme#1003

@mgeier
Copy link
Contributor

mgeier commented Dec 1, 2020

Is there any news on this?
Can this be merged?

@stsewd
Copy link
Member Author

stsewd commented Dec 3, 2020

We are already using the latest version of the rtd-sphinx-ext, but we still need to merge and release readthedocs/sphinx_rtd_theme#1003 first.

@mgeier
Copy link
Contributor

mgeier commented Dec 3, 2020

Thanks for the update!

@stsewd
Copy link
Member Author

stsewd commented Jan 4, 2021

A new release of the t heme is out, we can merge this now

@stsewd stsewd merged commit 96d1170 into master Jan 5, 2021
@stsewd stsewd deleted the use-html-base-url branch January 5, 2021 20:30
@ericholscher
Copy link
Member

I've confirmed this is working now on a doc rebuild with our latest deploy.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: blocked Issue is blocked on another issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Don't set "canonical" URL twice?
3 participants