From e98856b8ae5bffe4cdca5bfdd46f34386bd1f978 Mon Sep 17 00:00:00 2001 From: "zhang.lei" Date: Tue, 16 Jan 2018 03:01:10 +0000 Subject: [PATCH] Update the description of "giturl" Change-Id: Ie1ae735bd16abd5dba08fdfe27556f7ae0b14f04 --- openstackdocstheme/theme/openstackdocs/script_footer.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openstackdocstheme/theme/openstackdocs/script_footer.html b/openstackdocstheme/theme/openstackdocs/script_footer.html index 3b8c979e..1c42c238 100644 --- a/openstackdocstheme/theme/openstackdocs/script_footer.html +++ b/openstackdocstheme/theme/openstackdocs/script_footer.html @@ -41,9 +41,9 @@ /* there have been cases where "pagename" wasn't set; better check for it */ {%- if giturl and pagename %} - /* The URL of the source file on Git is based on the giturl variable - in conf.py, which must be manually initialized to the source file - URL in Git. + /* "giturl" is the URL of the source file on Git and is auto-generated by + openstackdocstheme. + "pagename" is a standard sphinx parameter containing the name of the source file, without extension. */