From: Nick Coghlan <ncoghlan@gmail.com>
Date: Tue, 6 Jun 2017 02:19:37 +0000 (+1000)
Subject: bpo-30052: Always regenerate cross-references (GH-1339) (GH-1921)
X-Git-Tag: v3.6.2rc1~97
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=798cfb212383a6f5a31b610825d1af1d376804b2;p=python

bpo-30052: Always regenerate cross-references (GH-1339) (GH-1921)

The patch for bpo-30052 changed the preferred link target
for :func:`bytes` and :func`bytearray` references to be the
respective type definitions rather than the corresponding
builtin function entries.

This patch changes the daily documentation builds to disable
the output caching in Sphinx, in order to ensure that
cross-reference changes like this one are reliably picked
up and applied automatically after merging.
(cherry picked from commit 7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7)
---

diff --git a/Doc/Makefile b/Doc/Makefile
index 94697f9567..ae59f3294f 100644
--- a/Doc/Makefile
+++ b/Doc/Makefile
@@ -159,15 +159,20 @@ serve:
 	../Tools/scripts/serve.py build/html
 
 # Targets for daily automated doc build
+# By default, Sphinx only rebuilds pages where the page content has changed.
+# This means it doesn't always pick up changes to preferred link targets, etc
+# To ensure such changes are picked up, we build the published docs with
+# `-E` (to ignore the cached environment) and `-a` (to ignore already existing
+# output files)
 
 # for development releases: always build
 autobuild-dev:
-	make dist SPHINXOPTS='$(SPHINXOPTS) -A daily=1 -A versionswitcher=1'
+	make dist SPHINXOPTS='$(SPHINXOPTS) -Ea -A daily=1 -A versionswitcher=1'
 	-make suspicious
 
 # for quick rebuilds (HTML only)
 autobuild-dev-html:
-	make html SPHINXOPTS='$(SPHINXOPTS) -A daily=1 -A versionswitcher=1'
+	make html SPHINXOPTS='$(SPHINXOPTS) -Ea -A daily=1 -A versionswitcher=1'
 
 # for stable releases: only build if not in pre-release stage (alpha, beta)
 # release candidate downloads are okay, since the stable tree can be in that stage
diff --git a/Misc/NEWS b/Misc/NEWS
index 86dd1b4543..1656e07f6e 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -192,6 +192,15 @@ Build
 Documentation
 -------------
 
+- Issue #30052: the link targets for :func:`bytes` and
+  :func:`bytearray` are now their respective type definitions, rather
+  than the corresponding builtin function entries. Use :ref:`bytes <func-bytes>`
+  and :ref:`bytearray <func-bytearray>` to reference the latter.
+
+  In order to ensure this and future cross-reference updates are applied
+  automatically, the daily documentation builds now disable the default
+  output caching features in Sphinx.
+
 - bpo-26985: Add missing info of code object in inspect documentation.
 
 Tools/Demos