From 5d07135a1e954cbf61ba29b52a2d71e84767979e Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 11 Jan 2021 19:45:55 +0900 Subject: [PATCH] Fix #8677: doc: Update description of html_baseurl --- doc/usage/configuration.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index e9e9190e6..8d8f3bedd 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -942,8 +942,11 @@ that use Sphinx's HTMLWriter class. .. confval:: html_baseurl - The URL which points to the root of the HTML documentation. It is used to - indicate the location of document like ``canonical_url``. + The base URL which points to the root of the HTML documentation. It is used + 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