mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Merge pull request #8678 from tk0miya/doc_html_baseurl
Fix #8677: doc: Update description of html_baseurl
This commit is contained in:
commit
f81310708b
@ -957,8 +957,11 @@ that use Sphinx's HTMLWriter class.
|
|||||||
|
|
||||||
.. confval:: html_baseurl
|
.. confval:: html_baseurl
|
||||||
|
|
||||||
The URL which points to the root of the HTML documentation. It is used to
|
The base URL which points to the root of the HTML documentation. It is used
|
||||||
indicate the location of document like ``canonical_url``.
|
to indicate the location of document using `The Canonical Link Relation`_.
|
||||||
|
Default: ``''``.
|
||||||
|
|
||||||
|
.. _The Canonical Link Relation: https://tools.ietf.org/html/rfc6596
|
||||||
|
|
||||||
.. versionadded:: 1.8
|
.. versionadded:: 1.8
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user