Skip to content

Commit

Permalink
Update guide
Browse files Browse the repository at this point in the history
  • Loading branch information
stsewd committed Oct 6, 2020
1 parent c76e363 commit f45f9b8
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/guides/canonical.rst
Expand Up @@ -31,6 +31,16 @@ Check your :guilabel:`Admin` > :guilabel:`Domains` page for the domains that we
Implementation
--------------

If you are using :doc:`Sphinx </intro/getting-started-with-sphinx>`,
Read the Docs will set the value of the html_baseurl_ setting (if isn't already set) to your canonical domain.

.. _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.

.. _site_url: https://www.mkdocs.org/user-guide/configuration/#site_url

If you look at the source code for documentation built after you set your canonical URL,
you should see a bit of HTML like this:

Expand Down

0 comments on commit f45f9b8

Please sign in to comment.