From e67cdb390a73341802da1deed57254276a294be5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= Date: Wed, 29 Dec 2021 09:58:48 +0100 Subject: [PATCH] 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. --- Makefile.docs | 2 ++ doc/arm/Makefile.am | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/Makefile.docs b/Makefile.docs index fe25d583e0..74650845b1 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 5a13110956..915f19c42a 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)