From: Michał Kępień <michal@isc.org>
Date: Wed, 29 Dec 2021 08:58:48 +0000 (+0100)
Subject: Clarify use of the "today" Sphinx variable
X-Git-Tag: v9.17.22~20^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e67cdb390a73341802da1deed57254276a294be5;p=thirdparty%2Fbind9.git

Clarify use of the "today" Sphinx variable

Add a comment explaining the purpose of setting the "today" variable in
Sphinx invocations to prevent confusion caused by the absence of that
variable from reStructuredText sources.

Drop the -A command-line option from the sphinx-build invocation for
EPUB output as "today" is already set in the ALLSPHINXOPTS variable.
---

diff --git a/Makefile.docs b/Makefile.docs
index fe25d583e02..74650845b19 100644
--- a/Makefile.docs
+++ b/Makefile.docs
@@ -15,6 +15,8 @@ common_SPHINXOPTS =			\
 	-a				\
 	$(SPHINX_V)
 
+# The "today" variable set below is not directly used in the ARM, but its value
+# is implicitly inserted on the title page of the PDF file produced by Sphinx.
 ALLSPHINXOPTS =				\
 	$(common_SPHINXOPTS)		\
 	-D today="$(RELEASE_DATE)"	\
diff --git a/doc/arm/Makefile.am b/doc/arm/Makefile.am
index 5a131109564..915f19c42aa 100644
--- a/doc/arm/Makefile.am
+++ b/doc/arm/Makefile.am
@@ -65,7 +65,7 @@ install-singlehtml: singlehtml
 	cp -R $(SPHINXBUILDDIR)/singlehtml/_static/* $(DESTDIR)/$(docdir)/_static/
 
 epub:
-	$(AM_V_SPHINX)$(SPHINX_BUILD) -b epub -A today=$(RELEASE_DATE) -d $(SPHINXBUILDDIR)/.doctrees/epub $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/epub
+	$(AM_V_SPHINX)$(SPHINX_BUILD) -b epub -d $(SPHINXBUILDDIR)/.doctrees/epub $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/epub
 
 install-epub:
 	$(INSTALL) -d $(DESTDIR)/$(docdir)