summaryrefslogtreecommitdiff
path: root/Misc
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2017-06-02 23:30:57 +1000
committerGitHub <noreply@github.com>2017-06-02 23:30:57 +1000
commit7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7 (patch)
tree1eb705a4f506725c54a2111135a373b81a719fdf /Misc
parentaead53b6ee27915de248b07de509529174aaad21 (diff)
downloadcpython-git-7a82f9c2b94d31c8f4cc8bb8e3151765d8b148d7.tar.gz
bpo-30052: Always regenerate cross-references (#1339)
* bpo-30052: Always regenerate cross-references 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.
Diffstat (limited to 'Misc')
-rw-r--r--Misc/NEWS9
1 files changed, 9 insertions, 0 deletions
diff --git a/Misc/NEWS b/Misc/NEWS
index 5066f57e14..902b102ac7 100644
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -1109,6 +1109,15 @@ C API
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.
- bpo-19824, bpo-20314, bpo-12518: Improve the documentation for, and links