IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Readme move canonical_url documentation

Browse Source
This commit is contained in:
Aaron Carlisle 2017-04-04 14:11:59 -04:00 committed by GitHub
parent dc9d3d732e
commit 1124c40137
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -48,15 +48,6 @@ In your ``conf.py`` file:
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
You may also specify a canonical url in conf.py to let search engines know
they should give higher ranking to latest version of the docs:
.. code:: python
html_theme_options['canonical_url'] = 'http://domain.tld/latest/docs/'
The url points to the root of the documentation. It requires a trailing slash.
Via git or download
-------------------
@ -89,6 +80,12 @@ file of this repository, and can be defined in your project's ``conf.py`` via
'navigation_depth': 3,
}
The following options are available:
* ``canonical_url`` This will specify a `canonical url <https://en.wikipedia.org/wiki/Canonical_link_element>`__
to let search engines know they should give higher ranking to latest version of the docs.
The url points to the root of the documentation and requires a trailing slash.
Page-level configuration
------------------------