Merge pull request #8678 from tk0miya/doc_html_baseurl

Fix #8677: doc: Update description of html_baseurl
This commit is contained in:
Takeshi KOMIYA 2021-01-14 01:10:12 +09:00 committed by GitHub
commit f81310708b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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