Skip to content

Commit f6f36e8

Browse files
committed
Update guide
1 parent b9726b8 commit f6f36e8

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/guides/canonical.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,16 @@ Check your :guilabel:`Admin` > :guilabel:`Domains` page for the domains that we
3131
Implementation
3232
--------------
3333

34+
If you are using :doc:`Sphinx </intro/getting-started-with-sphinx>`,
35+
Read the Docs will set the value of the html_baseurl_ setting (if isn't already set) to your canonical domain.
36+
37+
.. _html_baseurl: https://www.sphinx-doc.org/page/usage/configuration.html#confval-html_baseurl
38+
39+
If you are using :doc:`MkDocs </intro/getting-started-with-mkdocs>`,
40+
you can use the site_url_ setting.
41+
42+
.. _site_url: https://www.mkdocs.org/user-guide/configuration/#site_url
43+
3444
If you look at the source code for documentation built after you set your canonical URL,
3545
you should see a bit of HTML like this:
3646

0 commit comments

Comments
 (0)