Skip to content

Commit 1124c40

Browse files
authored
Readme move canonical_url documentation
1 parent dc9d3d7 commit 1124c40

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,6 @@ In your ``conf.py`` file:
4848
4949
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
5050
51-
You may also specify a canonical url in conf.py to let search engines know
52-
they should give higher ranking to latest version of the docs:
53-
54-
.. code:: python
55-
56-
html_theme_options['canonical_url'] = 'http://domain.tld/latest/docs/'
57-
58-
The url points to the root of the documentation. It requires a trailing slash.
59-
6051
Via git or download
6152
-------------------
6253

@@ -89,6 +80,12 @@ file of this repository, and can be defined in your project's ``conf.py`` via
8980
'navigation_depth': 3,
9081
}
9182
83+
The following options are available:
84+
85+
* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
86+
to let search engines know they should give higher ranking to latest version of the docs.
87+
The url points to the root of the documentation and requires a trailing slash.
88+
9289
Page-level configuration
9390
------------------------
9491

0 commit comments

Comments
 (0)